SchemeSetting Class Members
In This Topic
The following tables list the members exposed by SchemeSetting.
Public Constructors
Public Properties
| | Name | Description |
|---|
 | Description | Returns a multilingual description text of the scheme. |
| MLangName | Returns a multilingual scheme name. |
| ReadOnly | Gives write permission to settings of this scheme. |
TopPublic Methods
| | Name | Description |
|---|
 | CheckIfSchemeExists | Checks whether a scheme is defined. |
| CopyScheme | Copy an existing scheme. |
| CountSetting | Number of additional settings existing under the specified setting name. |
| CreateScheme | Create 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. |
| Dispose | For internal use only. Needed if the scheme exists in a project's settings Destructor for deterministic finalization of SchemeSetting object. |
| ExportScheme | Export a scheme to file. |
| ExportSchemes | Export all schemes to file. |
| 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. |
| GetCount | Returns the number of various schemes in this scheme. |
| 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. |
| GetLastUsed | Returns the last used scheme name (node LastUsed). |
| GetLocalizedNameSettingPath | Returns Setting path to the localized name of this scheme. |
| 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. |
| GetName | Returns a language-independent, internal scheme identifier. |
| GetNodeHandle | Returns the SettingNode of the data node of the current setting. The individual settings can now be accessed via the functions of the SettingNode. |
| GetNumericSetting | Reads numeric value from settings. It can be 16 bit or 32 bit, signed or unsigned setting. |
| 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. |
| ImportScheme | Import a scheme from file. |
| ImportSchemes | Import all schemes from file. |
| Init | Initializes object with a settings node path. |
| RemoveScheme | Remove a new scheme. |
| ResetScheme | Sets LastUsed as the current scheme. |
| Set | Setup internal members |
| 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. |
| SetLastUsed | Sets the strName scheme as the current one. Value in node LastUsed will be strName |
| 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 settings on a given path. Type of value will be converted to 16 bit, 32 bit, signed or unsigned value depending on setting type. |
| SetScheme | Overloaded. Sets a scheme by its name (LastUsed remains unchanged!) |
| 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. |
TopSee Also
