AddStringDefault Method (ProjectSettings)

In This Topic

Defines a new setting for a string default.

Syntax

C#
C++/CLI

public void AddStringDefault( 
   string strSettingPath,
   string[] arrDefaults,
   string[] arrRange,
   ISettings.CreationFlag eFlag
)

public:
void AddStringDefault( 
   String^ strSettingPath,
   array<String^>^ arrDefaults,
   array<String^>^ arrRange,
   ISettings.CreationFlag eFlag
)

Parameters

Parameter Name	Description
strSettingPath	Indicates the path of the setting.
arrDefaults	Array of default values
arrRange	Ranges used for value validation.
eFlag	Eplan.EplApi.Base.ISettings.CreationFlag

Exceptions

Exception	Description
System.ArgumentNullException	Thrown when `strSettingPath` is `null`.
System.ArgumentException	Thrown when `strSettingPath` is empty.
Eplan.EplApi.Base.BaseException	Thrown when setting cannot be added.

Remarks

Default definition settings are provided for settings that use default values such as FALSE, TRUE, 0, or spaces and that do not require ranges of values.

Reference

ProjectSettings Class
ProjectSettings Members

Use the Eplan Global Support Portal for feedback and support