IBomParameterDictionary interface

No description yet.

public interface IBomParameterDictionary

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
BoolValue	bool	get; set
FloatValue	double	get; set
IntValue	int	get; set
StrValue	string	get; set

BoolValue

No description yet.

bool GetBoolValue(string argName);
void SetBoolValue(string argName, bool argValue);

Type: bool · Access: read/write · Index: argName (string)

FloatValue

No description yet.

double GetFloatValue(string argName);
void SetFloatValue(string argName, double argValue);

Type: double · Access: read/write · Index: argName (string)

IntValue

No description yet.

int GetIntValue(string argName);
void SetIntValue(string argName, int argValue);

Type: int · Access: read/write · Index: argName (string)

StrValue

No description yet.

string GetStrValue(string argName);
void SetStrValue(string argName, string argValue);

Type: string · Access: read/write · Index: argName (string)

Methods

Method	Returns	Description
Clear	void
Contains	bool
GetCount	int
GetEnumerator	IBomParameterEnumerator
GetItem	IBomParameter
GetNameValuePairs	string
Remove	bool
TryGetParameter	bool

Clear

No description yet.

void Clear();

Returns: nothing (void)

Contains

No description yet.

bool Contains(string argName);

Parameter	Type	Passing
argName	string	value

Returns: bool

GetCount

No description yet.

int GetCount();

Returns: int

GetEnumerator

No description yet.

IBomParameterEnumerator GetEnumerator();

Returns: IBomParameterEnumerator

Extension method of IBomParameterDictionaryHelper (using EDP;).

Examples: Extension_BOMManager

GetItem

No description yet.

IBomParameter GetItem(string argName);

Parameter	Type	Passing
argName	string	value

Returns: IBomParameter

Extension method of IBomParameterDictionaryHelper (using EDP;).

GetNameValuePairs

No description yet.

string GetNameValuePairs(bool argIncludeSystemParameters);

Parameter	Type	Passing
argIncludeSystemParameters	bool	value

Returns: string

Remove

No description yet.

bool Remove(string argName);

Parameter	Type	Passing
argName	string	value

Returns: bool

TryGetParameter

No description yet.

bool TryGetParameter(string argName, out IBomParameter argParameter);

Parameter	Type	Passing
argName	string	value
argParameter	IBomParameter	out

Returns: bool

Examples: Extension_BOMManager

Returned by

IBomComponent.GetParameters, IBomGroup.GetParameters, IBomSchema.GetTotals