Settings Class

In This Topic

Settings are used to save values of variables beyond the runtime of the program and to make them available again the next time program is run (similar to the Windows registry). A setting has a unique identifier in the system. A value or a list of values can be saved to a setting. It is possible to group settings into structures SchemeSetting.

Inheritance Hierarchy

System.Object
Eplan.EplApi.Base.Settings

Syntax

C#
C++/CLI

public class Settings : ISettings

public ref class Settings : public ISettings

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

Access to a setting of the system

try
{
  String strGuiLanguage= new Settings().GetStringSetting("USER.SYSTEM.GUI.LANGUAGE", 0);
  new Decider().Decide(EnumDecisionType.eOkDecision, "The user interface language is set to: "+ strGuiLanguage, "", EnumDecisionReturn.eOK, EnumDecisionReturn.eOK);
}
catch (BaseException exc)
{
  String strMessage= exc.Message;
  new Decider().Decide(EnumDecisionType.eOkDecision, "Exception: " + strMessage, "", EnumDecisionReturn.eOK, EnumDecisionReturn.eOK);
}

Public Constructors

	Name	Description
	Settings Constructor	Default constructor

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 default setting for a multilanguage string value.
	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.
	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 Settings object.
	ExistSetting	Verifies whether specified setting exists.
	GetBoolDefault	Returns default boolean value of a setting. The index starts at 0.
	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.
	GetCountOfDefaultValues	Returnes the number of default values of a setting.
	GetCountOfValues	Returnes the number of values of a setting.
	GetDescription	\Returns the description of a setting.
	GetDoubleDefault	Returns default double value of a setting. The index starts at 0.
	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.
	GetExpandedStringSetting	Returns the value of a string setting. If a setting is read that has no value for this index, the default value is returned. The index starts at 0. If this path is identified via an EPLAN path (e.g. $Eplan, $MD, ...) this identifier is resolved.
	GetMultiLangStringDefault	Returns default MultiLangString value of a setting. The index starts at 0.
	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.
	GetNumericDefault	Returns default numeric value of a setting. The index starts at 0.
	GetNumericSetting	Reads numeric value from settings. It can be 16 bit or 32 bit, signed or unsigned setting.
	GetStringDefault	Returns default string value of a setting. The index starts at 0.
	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.
	GetTypeOfSetting	Returns the type of the setting.
	IsMainNodeReadOnly	Verifies whether the main node (COMPANY / STATION / USER) of the specified setting is Readonly.
	ReadSettings	Imports a settings xml file and sets all the settings it contains.
	RemoveAllIndexedSetting	Removes all indexed setting.
	SetBoolSetting	Overloaded. Sets the value of a setting. The index under which setting will be written is evaluated automatically. First free index is used. The index starts at 0.
	SetDoubleSetting	Overloaded. Sets the value of a setting. The index under which setting will be written is evaluated automatically. First free index is used. The index starts at 0.
	SetMultiLangStringSetting	Overloaded. Sets the value of a setting. The index under which setting will be written is evaluated automatically. First free index is used. The index starts at 0.
	SetNumericSetting	Overloaded. Sets the value of a setting. The index under which setting will be written is evaluated automatically. First free index is used. The index starts at 0.
	SetStringSetting	Overloaded. Sets the value of a setting. The index under which setting will be written is evaluated automatically. First free index is used. The index starts at 0.
	WriteSetting	Exports the specified setting to an XML file.

Top

Reference

Settings Members
Eplan.EplApi.Base Namespace
Working with settings

Send Feedback