IPCB_Parameter interface

A parameter, a name with a string value, held separately from any primitive.

public interface IPCB_Parameter

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Remarks

CreateParameter of IPCB_ParametersFactory creates a parameter. Changing a parameter does not change the parameters of a primitive: AddOrSetParameter and the other members of IPCB_PrimitiveParameters that take a parameter store its name, value and inherited mark, and the parameters they return are copies.

Properties

Property	Type	Access	Description
IsInherited	bool	get; set	Whether the parameter is marked as inherited.
Name	string	get; set	The name of the parameter.
Value	string	get; set	The value of the parameter, as a string.

IsInherited

Whether the parameter is marked as inherited.

bool GetIsInherited();
void SetIsInherited(bool argValue);

Type: bool · Access: read/write

The mark affects only the value, not whether the parameter exists: in a variant of a primitive's parameters (IPCB_PrimitiveParameters), a parameter marked as inherited shows the value of the default variant's parameter of the same name, or an empty value when the default variant has no such parameter. Setting Value removes the mark.

Name

The name of the parameter.

string GetName();
void SetName(string argValue);

Type: string · Access: read/write

Examples: Extension_BOMManager

Value

The value of the parameter, as a string.

string GetValue();
void SetValue(string argValue);

Type: string · Access: read/write

Setting it sets IsInherited to false.

Examples: Extension_BOMManager

Methods

Method	Returns	Description
GetAttributes	IPCB_ParameterAttributes	Returns the attributes of the parameter, additional information kept with it.

GetAttributes

Returns the attributes of the parameter, additional information kept with it.

IPCB_ParameterAttributes GetAttributes();

Returns: IPCB_ParameterAttributes

Extension method of IPCB_ParameterHelper (using PCB;).

The attributes are the parameter's own, not a copy.

Returned by

IPCB_ParameterList.ByIndex, IPCB_ParameterList.FindByName, IPCB_ParameterList.GetByName, IPCB_ParametersFactory.CreateParameter, IPCB_PrimitiveParameters.FindParameterByName, IPCB_PrimitiveParameters.GetParameterByIndex, IPCB_PrimitiveParameters.GetParameterByName

Accepted by

IPCB_ParameterList.Add, IPCB_PrimitiveParameters.AddOrSetParameter, IPCB_PrimitiveParameters.AddParameter, IPCB_PrimitiveParameters.SetParameter

Examples

Used in the SDK examples: Extension_BOMManager.