ProjectSchemeSetting Class

In This Topic

Inheritance Hierarchy
Syntax
Example
Public Constructors
Public Properties
Public Methods
See Also

Class for editing settings that are grouped into project schemes

Inheritance Hierarchy

System.Object
Eplan.EplApi.Base.SchemeSetting
Eplan.EplApi.DataModel.ProjectSchemeSetting

Syntax

C#
C++/CLI

public class ProjectSchemeSetting : Eplan.EplApi.Base.SchemeSetting

public ref class ProjectSchemeSetting : public Eplan.EplApi.Base.SchemeSetting

Example

Example of using ProjectSchemeSetting class

ProjectSchemeSetting oProjectSchemeSetting = new ProjectSchemeSetting();
oProjectSchemeSetting.Init("XEsInspectionGui.Scheme_Verifications", m_oTestProject);

string strSchemeName = "Offline";
if(oProjectSchemeSetting.CheckIfSchemeExists(strSchemeName))
{
    oProjectSchemeSetting.SetScheme(strSchemeName);
    oProjectSchemeSetting.SetNumericSetting("001001.VerificationType", 1, 0);
}

Public Constructors

	Name	Description
	ProjectSchemeSetting Constructor	Default constructor

Top

Public Properties

	Name	Description
	Description	Returns a multilingual description text of the scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	MLangName	Returns a multilingual scheme name. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	ReadOnly	Gives write permission to settings of this scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)

Top

Public Methods

	Name	Description
	CheckIfSchemeExists	Checks whether a scheme is defined. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	CopyScheme	Copy an existing scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	CountSetting	Number of additional settings existing under the specified setting name. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	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. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	Dispose()	Virtual deterministic destructor. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	ExportScheme	Export a scheme to file. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	ExportSchemes	Export all schemes to file. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	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. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	GetCount	Returns the number of various schemes in this scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	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. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	GetLastUsed	Returns the last used scheme name (node LastUsed). (Inherited from Eplan.EplApi.Base.SchemeSetting)
	GetLocalizedNameSettingPath	Returns Setting path to the localized name of this scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	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. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	GetName	Returns a language-independent, internal scheme identifier. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	GetNodeHandle	Returns the Eplan.EplApi.Base.SettingNode of the data node of the current setting. The individual settings can now be accessed via the functions of the Eplan.EplApi.Base.SettingNode. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	GetNumericSetting	Reads numeric value from settings. It can be 16 bit or 32 bit, signed or unsigned setting. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	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. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	ImportScheme	Import a scheme from file. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	ImportSchemes	Import all schemes from file. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	Init	Overloaded. Overridden. Initializes object with a settings node path.
	RemoveScheme	Remove a new scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	ResetScheme	Sets LastUsed as the current scheme. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	Set	Overridden. 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. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	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. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	SetLastUsed	Sets the strName scheme as the current one. Value in node LastUsed will be strName (Inherited from Eplan.EplApi.Base.SchemeSetting)
	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. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	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. (Inherited from Eplan.EplApi.Base.SchemeSetting)
	SetScheme	Overloaded. Sets a scheme by its name (LastUsed remains unchanged!) (Inherited from Eplan.EplApi.Base.SchemeSetting)
	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. (Inherited from Eplan.EplApi.Base.SchemeSetting)

Top

Reference

ProjectSchemeSetting Members
Eplan.EplApi.DataModel Namespace
WorkingWithSettings

Send Feedback