Skip to main content
View as Markdown

CParameterList class

No description yet.

public class CParameterList

Namespace: DXP · Assembly: Altium.SDK

Constructors​

public CParameterList();

Methods​

MethodReturnsDescription
ClearAllParametersvoid
DecodeParameterStringstring
EncodeParameterStringstring
GetStatestring
GetStateParameterbool
GetStateParameterAsStringbool
GetStateParameterAsWordbool
GetStateParameterByNameCParameter
GetStateToStringstring
SetStatevoid
SetStateAddParametervoid
SetStateFromStringvoid
SetStateParametervoid
SetStateRemoveByNamebool
SetStateRemoveParametervoid

ClearAllParameters​

No description yet.

static void ClearAllParameters();

Returns: nothing (void)

DecodeParameterString​

No description yet.

string DecodeParameterString(string artStr);
ParameterTypePassing
artStrstringvalue

Returns: string

EncodeParameterString​

No description yet.

static string EncodeParameterString(string argStr);
ParameterTypePassing
argStrstringvalue

Returns: string

GetState​

No description yet.

static string GetState();

Returns: string

GetStateParameter​

No description yet.

static bool GetStateParameter(string argStr, string argName, out string argValue);
ParameterTypePassing
argStrstringvalue
argNamestringvalue
argValuestringout

Returns: bool

GetStateParameterAsString​

No description yet.

static bool GetStateParameterAsString(string argName, out string argValue);
ParameterTypePassing
argNamestringvalue
argValuestringout

Returns: bool

GetStateParameterAsWord​

No description yet.

static bool GetStateParameterAsWord(string argName, out ushort argValue);
ParameterTypePassing
argNamestringvalue
argValueushortout

Returns: bool

GetStateParameterByName​

No description yet.

static CParameter GetStateParameterByName(string argName);
ParameterTypePassing
argNamestringvalue

Returns: CParameter

GetStateToString​

No description yet.

static string GetStateToString();

Returns: string

SetState​

No description yet.

static void SetState(string argState);
ParameterTypePassing
argStatestringvalue

Returns: nothing (void)

SetStateAddParameter​

No description yet.

static void SetStateAddParameter(string argName, object argValue);
ParameterTypePassing
argNamestringvalue
argValueobjectvalue

Returns: nothing (void)

SetStateFromString​

No description yet.

static void SetStateFromString(string argStr);
ParameterTypePassing
argStrstringvalue

Returns: nothing (void)

SetStateParameter​

No description yet.

static void SetStateParameter(string argStr, string argName, string argValue);
ParameterTypePassing
argStrstringvalue
argNamestringvalue
argValuestringvalue

Returns: nothing (void)

SetStateRemoveByName​

No description yet.

static bool SetStateRemoveByName(string argName);
ParameterTypePassing
argNamestringvalue

Returns: bool

SetStateRemoveParameter​

No description yet.

static void SetStateRemoveParameter(string argStr, string argName);
ParameterTypePassing
argStrstringvalue
argNamestringvalue

Returns: nothing (void)