API Help
Eplan.EplApi.DataModel Namespace / ProjectSchemeSetting Class
Members Example

In This Topic
    ProjectSchemeSetting Class
    In This Topic
    Class for editing settings that are grouped into project schemes
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.Base.SchemeSetting
          Eplan.EplApi.DataModel.ProjectSchemeSetting

    Syntax
    public class ProjectSchemeSetting : Eplan.EplApi.Base.SchemeSetting 
    public ref class ProjectSchemeSetting : public Eplan.EplApi.Base.SchemeSetting 
    Example
    Example of using ProjectSchemeSetting class
    ProjectSchemeSetting oProjectSchemeSetting = new ProjectSchemeSetting();
    oProjectSchemeSetting.Init("XEsInspectionGui.Scheme_Verifications", m_oTestProject);
    
    string strSchemeName = "Offline";
    if(oProjectSchemeSetting.CheckIfSchemeExists(strSchemeName))
    {
        oProjectSchemeSetting.SetScheme(strSchemeName);
        oProjectSchemeSetting.SetNumericSetting("001001.VerificationType", 1, 0);
    }
    
    
    Public Constructors
     NameDescription
    Public ConstructorDefault constructor  
    Top
    Public Properties
     NameDescription
    Public PropertyReturns a multilingual description text of the scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public PropertyReturns a multilingual scheme name. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public PropertyGives write permission to settings of this scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Top
    Public Methods
     NameDescription
    Public MethodChecks whether a scheme is defined. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodCopy an existing scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodNumber of additional settings existing under the specified setting name. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodCreate a new scheme with a specified name, description and the node name for the settings. The data for the new scheme is specified by P8 for each scheme type. The data is the same as the new button in the scheme dialog of P8. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodVirtual deterministic destructor. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodExport a scheme to file. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodExport all schemes to file. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodReturns the value of a setting. If a setting is read that has no value for this index, the default value is returned. The index starts at 0. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodReturns the number of various schemes in this scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodReturns the value of a setting. If a setting is read that has no value for this index, the default value is returned. The index starts at 0. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodReturns the last used scheme name (node LastUsed). (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodReturns Setting path to the localized name of this scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodReturns the value of a setting. If a setting is read that has no value for this index, the default value is returned. The index starts at 0. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodReturns a language-independent, internal scheme identifier. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodReturns the Eplan.EplApi.Base.SettingNode of the data node of the current setting. The individual settings can now be accessed via the functions of the Eplan.EplApi.Base.SettingNode. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodReads numeric value from settings. It can be 16 bit or 32 bit, signed or unsigned setting. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodReturns the value of a setting. If a setting is read that has no value for this index, the default value is returned. The index starts at 0. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodImport a scheme from file. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodImport all schemes from file. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodOverloaded. Overridden. Initializes object with a settings node path.  
    Public MethodRemove a new scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodSets LastUsed as the current scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodOverridden. Setup internal members  
    Public MethodSets the value of a setting. If a setting is made and an index is specified that exceeds the number of values, the corresponding values are created, based on the predefined value. The index starts at 0. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodSets the value of a setting. If a setting is made and an index is specified that exceeds the number of values, the corresponding values are created, based on the predefined value. The index starts at 0. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodSets the strName scheme as the current one. Value in node LastUsed will be strName (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodSets the value of a setting. If a setting is made and an index is specified that exceeds the number of values, the corresponding values are created, based on the predefined value. The index starts at 0. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodSets the value of settings on a given path. Type of value will be converted to 16 bit, 32 bit, signed or unsigned value depending on setting type. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodOverloaded. Sets a scheme by its name (LastUsed remains unchanged!) (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Public MethodSets the value of a setting. If a setting is made and an index is specified that exceeds the number of values, the corresponding values are created, based on the predefined value. The index starts at 0. (Inherited from Eplan.EplApi.Base.SchemeSetting)
    Top
    See Also