API Help
Eplan.EplApi.Base Namespace / Settings Class
Members Example

In This Topic
    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
    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
     NameDescription
    Public ConstructorDefault constructor  
    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 default setting for a multilanguage string value.  
    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 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 Settings object.  
    Public MethodVerifies whether specified setting exists.  
    Public MethodReturns default boolean value of a setting. The index starts at 0.  
    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 MethodReturnes the number of default values of a setting.  
    Public MethodReturnes the number of values of a setting.  
    Public Method\Returns the description of a setting.  
    Public MethodReturns default double value of a setting. The index starts at 0.  
    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 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.  
    Public MethodReturns default MultiLangString value of a setting. The index starts at 0.  
    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 default numeric value of a setting. The index starts at 0.  
    Public MethodReads numeric value from settings. It can be 16 bit or 32 bit, signed or unsigned setting.  
    Public MethodReturns default string value of a setting. The index starts at 0.  
    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 type of the setting.  
    Public MethodVerifies whether the main node (COMPANY / STATION / USER) of the specified setting is Readonly.  
    Public MethodImports a settings xml file and sets all the settings it contains.  
    Public MethodRemoves all indexed setting.  
    Public MethodOverloaded. 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.  
    Public MethodOverloaded. 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.  
    Public MethodOverloaded. 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.  
    Public MethodOverloaded. 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.  
    Public MethodOverloaded. 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.  
    Public MethodExports the specified setting to an XML file.  
    Top
    See Also