ParameterList class

No description yet.

public class ParameterList

Namespace: DXP · Assembly: Altium.SDK

Constructors

public ParameterList();
public ParameterList(string parametersString);

Properties

Property	Type	Access	Description
Count	int	get
Item	Parameter	get

Count

No description yet.

int Count { get; }

Type: int · Access: read-only

Item

No description yet.

Parameter Item { get; }

Type: Parameter · Access: read-only

Methods

Method	Returns	Description
AddOrReplaceParameter	void
AddParameter	void
Clear	void
FindParameter	Parameter
FindParameters	Parameter[]
GetParameter	Parameter
GetParameterAsString	bool
GetParameterValue	string
GetParameterValueAsBool	bool
GetParameterValueAsInt	bool
GetParameterValueDef	string
RemoveParameter	void
SetParameters	void
ToString	string

AddOrReplaceParameter

No description yet.

void AddOrReplaceParameter(string name, string value);
void AddOrReplaceParameter(string name, bool value);

Overload 1: void AddOrReplaceParameter(string name, string value)

Parameter	Type	Passing
name	string	value
value	string	value

Returns nothing (void).

Overload 2: void AddOrReplaceParameter(string name, bool value)

Parameter	Type	Passing
name	string	value
value	bool	value

Returns nothing (void).

AddParameter

No description yet.

void AddParameter(string name, string value);
void AddParameter(string name, object value);
void AddParameter(string name, bool value);
void AddParameter(string name, float value);
void AddParameter(string name, double value);

Overload 1: void AddParameter(string name, string value)

Parameter	Type	Passing
name	string	value
value	string	value

Returns nothing (void).

Overload 2: void AddParameter(string name, object value)

Parameter	Type	Passing
name	string	value
value	object	value

Returns nothing (void).

Overload 3: void AddParameter(string name, bool value)

Parameter	Type	Passing
name	string	value
value	bool	value

Returns nothing (void).

Overload 4: void AddParameter(string name, float value)

Parameter	Type	Passing
name	string	value
value	float	value

Returns nothing (void).

Overload 5: void AddParameter(string name, double value)

Parameter	Type	Passing
name	string	value
value	double	value

Returns nothing (void).

Clear

No description yet.

void Clear();

Returns: nothing (void)

FindParameter

No description yet.

Parameter FindParameter(string name);

Parameter	Type	Passing
name	string	value

Returns: Parameter

FindParameters

No description yet.

Parameter[] FindParameters(string name);

Parameter	Type	Passing
name	string	value

Returns: Parameter[]

GetParameter

No description yet.

Parameter GetParameter(string name);

Parameter	Type	Passing
name	string	value

Returns: Parameter

GetParameterAsString

No description yet.

bool GetParameterAsString(string name, ref string value);

Parameter	Type	Passing
name	string	value
value	string	ref

Returns: bool

GetParameterValue

No description yet.

string GetParameterValue(string name);

Parameter	Type	Passing
name	string	value

Returns: string

GetParameterValueAsBool

No description yet.

bool GetParameterValueAsBool(string name, ref bool value);

Parameter	Type	Passing
name	string	value
value	bool	ref

Returns: bool

GetParameterValueAsInt

No description yet.

bool GetParameterValueAsInt(string name, ref int value);

Parameter	Type	Passing
name	string	value
value	int	ref

Returns: bool

GetParameterValueDef

No description yet.

string GetParameterValueDef(string name, string defaultValue);
bool GetParameterValueDef(string name, bool defaultValue);

Overload 1: string GetParameterValueDef(string name, string defaultValue)

Parameter	Type	Passing
name	string	value
defaultValue	string	value

Returns string.

Overload 2: bool GetParameterValueDef(string name, bool defaultValue)

Parameter	Type	Passing
name	string	value
defaultValue	bool	value

Returns bool.

RemoveParameter

No description yet.

void RemoveParameter(string name);

Parameter	Type	Passing
name	string	value

Returns: nothing (void)

SetParameters

No description yet.

void SetParameters(string parametersString);

Parameter	Type	Passing
parametersString	string	value

Returns: nothing (void)

ToString

No description yet.

string ToString();

Returns: string