Eplan Platform API
Eplan.EplApi.Base Namespace / SchemeSetting Class
Properties Methods

In This Topic
    SchemeSetting Class Members
    In This Topic

    The following tables list the members exposed by SchemeSetting.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyReturns a multilingual description text of the scheme.  
    Public PropertyReturns a multilingual scheme name.  
    Public PropertyGives write permission to settings of this scheme.  
    Top
    Public Methods
     NameDescription
    Public MethodChecks whether a scheme is defined.  
    Public MethodCopy an existing scheme.  
    Public MethodNumber of additional settings existing under the specified setting name.  
    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.  
    Public MethodFor internal use only. Needed if the scheme exists in a project's settings Destructor for deterministic finalization of SchemeSetting object.  
    Public MethodExport a scheme to file.  
    Public MethodExport all schemes to file.  
    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.  
    Public MethodReturns the number of various schemes in this scheme.  
    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.  
    Public MethodReturns the last used scheme name (node LastUsed).  
    Public MethodReturns Setting path to the localized name of this scheme.  
    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.  
    Public MethodReturns a language-independent, internal scheme identifier.  
    Public MethodReturns the SettingNode of the data node of the current setting. The individual settings can now be accessed via the functions of the SettingNode.  
    Public MethodReads numeric value from settings. It can be 16 bit or 32 bit, signed or unsigned setting.  
    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.  
    Public MethodImport a scheme from file.  
    Public MethodImport all schemes from file.  
    Public MethodInitializes object with a settings node path.  
    Public MethodRemove a new scheme.  
    Public MethodSets LastUsed as the current scheme.  
    Public MethodSetup 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.  
    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.  
    Public MethodSets the strName scheme as the current one. Value in node LastUsed will be strName  
    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.  
    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.  
    Public MethodOverloaded. Sets a scheme by its name (LastUsed remains unchanged!)  
    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.  
    Top
    See Also

    Reference

    SchemeSetting Class
    Eplan.EplApi.Base Namespace
    WorkingWithSettings