IInternalOptions interface
No description yet.
public interface IInternalOptions
Namespace: DXP · Assembly: Altium.SDK.Interfaces
Methods
| Method | Returns | Description |
|---|---|---|
| DefineFeatureBoolean | bool | |
| DefineFeatureDouble | bool | |
| DefineFeatureInteger | bool | |
| DefineFeatureString | bool | |
| InDevelopment | bool | |
| IsBetaFeaturesEnabled | bool | |
| IsDevFeaturesEnabled | bool | |
| IsOptionInBetaStage | bool | |
| OptionExists | bool | |
| ReadBoolean | bool | |
| ReadDouble | double | |
| ReadInteger | int | |
| ReadString | string | |
| RemoveFeature | void |
DefineFeatureBoolean
No description yet.
bool DefineFeatureBoolean(string argServerName, string argName, TStateOfFeature argstate, bool argPublicDefaultValue, bool argBetaDefaultValue, string argDescription, string argRelatedOption);
bool DefineFeatureBoolean(string argServerName, string argName, int argstate, bool argPublicDefaultValue, bool argBetaDefaultValue, string argDescription, string argRelatedOption);
| Parameter | Type | Passing |
|---|---|---|
argServerName | string | value |
argName | string | value |
argstate | TStateOfFeature | value |
argPublicDefaultValue | bool | value |
argBetaDefaultValue | bool | value |
argDescription | string | value |
argRelatedOption | string | value |
Returns: bool
The first overload is an extension method of IInternalOptionsHelper (using DXP;) with typed parameters; the second is declared by the interface.
DefineFeatureDouble
No description yet.
bool DefineFeatureDouble(string argServerName, string argName, TStateOfFeature argstate, double argPublicDefaultValue, double argBetaDefaultValue, string argDescription, string argRelatedOption);
bool DefineFeatureDouble(string argServerName, string argName, int argstate, double argPublicDefaultValue, double argBetaDefaultValue, string argDescription, string argRelatedOption);
| Parameter | Type | Passing |
|---|---|---|
argServerName | string | value |
argName | string | value |
argstate | TStateOfFeature | value |
argPublicDefaultValue | double | value |
argBetaDefaultValue | double | value |
argDescription | string | value |
argRelatedOption | string | value |
Returns: bool
The first overload is an extension method of IInternalOptionsHelper (using DXP;) with typed parameters; the second is declared by the interface.
DefineFeatureInteger
No description yet.
bool DefineFeatureInteger(string argServerName, string argName, TStateOfFeature argstate, int argPublicDefaultValue, int argBetaDefaultValue, string argDescription, string argRelatedOption, int argMinValue, int argMaxValue);
bool DefineFeatureInteger(string argServerName, string argName, int argstate, int argPublicDefaultValue, int argBetaDefaultValue, string argDescription, string argRelatedOption, int argMinValue, int argMaxValue);
| Parameter | Type | Passing |
|---|---|---|
argServerName | string | value |
argName | string | value |
argstate | TStateOfFeature | value |
argPublicDefaultValue | int | value |
argBetaDefaultValue | int | value |
argDescription | string | value |
argRelatedOption | string | value |
argMinValue | int | value |
argMaxValue | int | value |
Returns: bool
The first overload is an extension method of IInternalOptionsHelper (using DXP;) with typed parameters; the second is declared by the interface.
DefineFeatureString
No description yet.
bool DefineFeatureString(string argServerName, string argName, TStateOfFeature argstate, string argPublicDefaultValue, string argBetaDefaultValue, string argDescription, string argRelatedOption);
bool DefineFeatureString(string argServerName, string argName, int argstate, string argPublicDefaultValue, string argBetaDefaultValue, string argDescription, string argRelatedOption);
| Parameter | Type | Passing |
|---|---|---|
argServerName | string | value |
argName | string | value |
argstate | TStateOfFeature | value |
argPublicDefaultValue | string | value |
argBetaDefaultValue | string | value |
argDescription | string | value |
argRelatedOption | string | value |
Returns: bool
The first overload is an extension method of IInternalOptionsHelper (using DXP;) with typed parameters; the second is declared by the interface.
InDevelopment
No description yet.
bool InDevelopment(string argValueName);
| Parameter | Type | Passing |
|---|---|---|
argValueName | string | value |
Returns: bool
IsBetaFeaturesEnabled
No description yet.
bool IsBetaFeaturesEnabled();
Returns: bool
IsDevFeaturesEnabled
No description yet.
bool IsDevFeaturesEnabled();
Returns: bool
IsOptionInBetaStage
No description yet.
bool IsOptionInBetaStage(string argValueName);
| Parameter | Type | Passing |
|---|---|---|
argValueName | string | value |
Returns: bool
OptionExists
No description yet.
bool OptionExists(string argValueName);
| Parameter | Type | Passing |
|---|---|---|
argValueName | string | value |
Returns: bool
ReadBoolean
No description yet.
bool ReadBoolean(string argValueName);
| Parameter | Type | Passing |
|---|---|---|
argValueName | string | value |
Returns: bool
ReadDouble
No description yet.
double ReadDouble(string argValueName);
| Parameter | Type | Passing |
|---|---|---|
argValueName | string | value |
Returns: double
ReadInteger
No description yet.
int ReadInteger(string argValueName);
| Parameter | Type | Passing |
|---|---|---|
argValueName | string | value |
Returns: int
ReadString
No description yet.
string ReadString(string argValueName);
| Parameter | Type | Passing |
|---|---|---|
argValueName | string | value |
Returns: string
RemoveFeature
No description yet.
void RemoveFeature(string argName);
| Parameter | Type | Passing |
|---|---|---|
argName | string | value |
Returns: nothing (void)
Returned by
IClient.GetInternalOptions, GlobalVars.InternalOptions