IParameter interface

The IParameter interface is a parameter object interface to an existing parameter object on a schematic sheet. There are two types of parameters - system parameters which are owned by a schematic document and parameters owned by certain schematic design objects.

public interface IParameter : IAbstractObject

Namespace: ComponentLib · Assembly: Altium.SDK.Interfaces

Inherits: IAbstractObject

Remarks

A parameter is a child object of a Parameter Set, Part, Pin, Port, or Sheet Symbol object. A Parameter object has a Name property and Value property which can be used to store information, thus the parameters are a way of defining and associating information and could include strings that identify component manufacturer, date added to the document and also a string for the component's value (e.g. 100K for a resistor or 10PF for a capacitor).

Each parameter has a Unique Id assigned to it. This is used for those parameters that have been added as design rule directives. When transferring the design to the PCB document, any defined rule parameters will be used to generate the relevant design rules in the PCB. These generated rules will be given the same Unique Ids, allowing you to change rule constraints in either schematic or PCB and push the change across when performing a synchronization.

An equivalent object representation is the ISch_Parameter class in the Sch API reference.

Properties

Property	Type	Access	Description
RealValue	double	get; set
RequiredParameter	IRequiredParameter	get; set
Value	string	get; set

RealValue

No description yet.

double GetRealValue();
void SetRealValue(double argValue);

Type: double · Access: read/write

RequiredParameter

No description yet.

IRequiredParameter GetRequiredParameter();
void SetRequiredParameter(IRequiredParameter argValue);

Type: IRequiredParameter · Access: read/write

The accessors are extension methods of IParameterHelper (using ComponentLib;).

Value

No description yet.

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

Type: string · Access: read/write

Methods

Method	Returns	Description
GetName	string
IsSystemParameter	bool

GetName

No description yet.

string GetName();

Returns: string

IsSystemParameter

No description yet.

bool IsSystemParameter();

Returns: bool

Returned by

IAbstractItem.FindParameterByName, IComponentLibraryDocument.CreateParameter, IComponentLibraryManager.CreateParameter, IParameterList.Get

Accepted by

IParameterList.Add

Examples

Used in the SDK examples: Extension_AddVariant, Extension_PartComment.