Eplan Platform API
Eplan.EplApi.Base Namespace / SettingNode Class
Members Example

In This Topic
    SettingNode Class
    In This Topic
    Allows access to settings and relative access to setting-nodes. A setting key consists of a number of sections separated by '.' Each section except the last one is called a setting-node. Setting-nodes and settings together build the settings tree. The settings are the leaves of this tree. The SettingNode class helps iterating trough the nodes and e.g. gives you the possibility to delete a node completely.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.Base.SettingNode
          Eplan.EplApi.DataModel.ProjectSettingNode

    Syntax
    public class SettingNode 
    public ref class SettingNode 
    Remarks
    Due to changes in EPLAN, it may happen that settings will change their type or name or that some settings will be completely removed. We cannot guarantee the long-term compatibility of settings. When updating to a newer version, please check your source code, whether the settings you use are still working.
    Example
    Example of using relative path to access entries
    // Create setting node with path STATION.AF.Service.Actions.ActionNewModell
    SettingNode oSettingNode = new SettingNode("STATION.AF.Services.Actions.ActionNewModell");
    // Set or get setting relative to the path of the node
    oSettingNode.SetStringSetting("ModuleName.10", "Service3DLog", 0);
    string str = oSettingNode.GetStringSetting("ModuleName.10", 0);
    
    
    Example of merging 2 nodes
    SettingNode oTestNode1 = new SettingNode("STATION.AF.Services.Actions.ActionNewModell");
    Console.WriteLine(oTestNode1.GetCountOfNodes().ToString()); //  1
    
    SettingNode oTestNode2 = new SettingNode("STATION.AF.Services.Actions.AdjustFromAllLineToSingleLineAndOverview");
    Console.WriteLine(oTestNode2.GetCountOfNodes().ToString()); //  1
    
    oTestNode1.MergeWithNode(oTestNode2);
    Console.WriteLine(oTestNode1.GetCountOfNodes().ToString()); //  2
    
    
    Example of listing sub-nodes
    SettingNode oSettingNode = new SettingNode("STATION.AF.Modules");
    StringCollection oSubnodes = new StringCollection();
    oSettingNode.GetListOfNodes(ref oSubnodes, false);
    foreach (string sSubNode in oSubnodes)
    {
        SettingNode oSubNode = oSettingNode.GetSubNode(sSubNode);
        Console.WriteLine(oSubNode.GetNodePath());
    }
    
    
    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Methods
     NameDescription
    Public MethodDefines a new setting for a boolean default.  
    Public MethodDefines a new setting for a boolean value.  
    Public MethodDefines a new setting for a double default.  
    Public MethodDefines a new setting for a double value.  
    Public MethodDefines a new setting for a multilanguage string default.  
    Public MethodDefines a new setting for a multilanguage string value.  
    Public MethodDefines a new setting for a numeric default.  
    Public MethodDefines a new setting for a numeric value.  
    Public MethodDefines a new setting for a string default.  
    Public MethodDefines a new setting for a string value.  
    Public MethodOverloaded. Deletes the value. The setting definition is maintained.  
    Public MethodResets an individual setting to the value of the corresponding default setting. If it has no default setting, the setting is deleted.  
    Public MethodDestructor for deterministic finalization of SettingNode object.  
    Public MethodVerifies whether specified setting exists.  
    Public MethodReloads settings node.  
    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 MethodDetermines the number of child nodes.  
    Public MethodDetermines the number of child settings (subordinate settings).  
    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 MethodDetermines all settings.  
    Public MethodDetermines all settings nodes.  
    Public MethodDetermines all settings of this node.  
    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 MethodDetermines the path of this node.  
    Public MethodDetermines the path of this node.  
    Public MethodReads numeric value from settings. It can be 16 bit or 32 bit, signed or unsigned setting.  
    Public MethodDetermines the parent node.  
    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 MethodDetermines a child node.  
    Public MethodMerges settings nodes.  
    Public MethodResets the node to default. All settings inside are deleted and copied from defaults again.  
    Public MethodDefines the path to the settings node.  
    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 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 project 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 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 MethodWrites all settings to a file.  
    Top
    See Also