SettingNode Class

In This Topic

Inheritance Hierarchy
Syntax
Remarks
Example
Public Constructors
Public Methods
See Also

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

C#
C++/CLI

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 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

	Name	Description
	SettingNode Constructor	Overloaded.

Top

Public Methods

	Name	Description
	AddBoolDefault	Defines a new setting for a boolean default.
	AddBoolSetting	Defines a new setting for a boolean value.
	AddDoubleDefault	Defines a new setting for a double default.
	AddDoubleSetting	Defines a new setting for a double value.
	AddMultiLangStringDefault	Defines a new setting for a multilanguage string default.
	AddMultiLangStringSetting	Defines a new setting for a multilanguage string value.
	AddNumericDefault	Defines a new setting for a numeric default.
	AddNumericSetting	Defines a new setting for a numeric value.
	AddStringDefault	Defines a new setting for a string default.
	AddStringSetting	Defines a new setting for a string value.
	ClearSetting	Overloaded. Deletes the value. The setting definition is maintained.
	DeleteSetting	Resets an individual setting to the value of the corresponding default setting. If it has no default setting, the setting is deleted.
	Dispose	Destructor for deterministic finalization of SettingNode object.
	ExistSetting	Verifies whether specified setting exists.
	ForceReload	Reloads settings node.
	GetBoolSetting	Returns 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.
	GetCountOfNodes	Determines the number of child nodes.
	GetCountOfSettings	Determines the number of child settings (subordinate settings).
	GetDoubleSetting	Returns 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.
	GetListOfAllSettings	Determines all settings.
	GetListOfNodes	Determines all settings nodes.
	GetListOfSettings	Determines all settings of this node.
	GetMultiLangStringSetting	Returns 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.
	GetNodePath	Determines the path of this node.
	GetNodePathDot	Determines the path of this node.
	GetNumericSetting	Reads numeric value from settings. It can be 16 bit or 32 bit, signed or unsigned setting.
	GetParentNode	Determines the parent node.
	GetStringSetting	Returns 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.
	GetSubNode	Determines a child node.
	MergeWithNode	Merges settings nodes.
	ResetNode	Resets the node to default. All settings inside are deleted and copied from defaults again.
	Set	Defines the path to the settings node.
	SetBoolSetting	Sets 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.
	SetDoubleSetting	Sets 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.
	SetMultiLangStringSetting	Sets 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.
	SetNumericSetting	Sets 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.
	SetStringSetting	Sets 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.
	Write	Writes all settings to a file.

Top

Reference

SettingNode Members
Eplan.EplApi.Base Namespace

Send Feedback