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 : IDMObject

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IDMObject

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.

Methods

Method	Returns	Description
DM_ConfigurationName	string	The method returns the configuration name, that the parameter object is associated with.
DM_Description	string	The method denotes the description of this parameter object.
DM_Kind	TParameterKind	The method denotes the specific kind that can be assigned to this parameter object.
DM_Name	string	The method denotes the name of the parameter object.
DM_NewName	string	The method denotes the New Name for the parameter object, especially when there is an ECO change.
DM_NewValue	string	The method denotes the New Value for the parameter object, especially when there is an ECO change.
DM_OriginalOwner	IDMObject	This method returns the interface of the owner object this parameter object is associated with.
DM_RawText	string	The method returns the raw text for this parameter object.
DM_SetValue	void
DM_UniqueId	string	Any parameter that is configured as a container for design rule directives need to have a unique ID that will be ported onto the corresponding PCB implementation document.
DM_Value	string	The method denotes the value placeholder for this parameter object.
DM_Visible	bool	The method denotes whether this parameter object is visible or not.

DM_ConfigurationName

The method returns the configuration name, that the parameter object is associated with.

string DM_ConfigurationName();

Returns: string

DM_Description

The method denotes the description of this parameter object.

string DM_Description();

Returns: string

DM_Kind

The method denotes the specific kind that can be assigned to this parameter object. String, Boolean, Integer or float.

TParameterKind DM_Kind();

Returns: TParameterKind

Extension method of IParameterHelper (using EDP;).

See also: TParameterKind

DM_Name

The method denotes the name of the parameter object.

string DM_Name();

Returns: string

Examples: Extension_BOMManager

DM_NewName

The method denotes the New Name for the parameter object, especially when there is an ECO change. You can then compare the original and new names.

string DM_NewName();

Returns: string

DM_NewValue

The method denotes the New Value for the parameter object, especially when there is an ECO change. You can then compare the original and new values.

string DM_NewValue();

Returns: string

DM_OriginalOwner

This method returns the interface of the owner object this parameter object is associated with.

IDMObject DM_OriginalOwner();

Returns: IDMObject

Extension method of IParameterHelper (using EDP;).

DM_RawText

The method returns the raw text for this parameter object.

string DM_RawText();

Returns: string

DM_SetValue

No description yet.

void DM_SetValue(string argValue);

Parameter	Type	Passing
argValue	string	value

Returns: nothing (void)

DM_UniqueId

Any parameter that is configured as a container for design rule directives need to have a unique ID that will be ported onto the corresponding PCB implementation document.

string DM_UniqueId();

Returns: string

The method returns the Unique ID value for the parameter object.

DM_Value

The method denotes the value placeholder for this parameter object.

string DM_Value();

Returns: string

Examples: Extension_BOMManager

DM_Visible

The method denotes whether this parameter object is visible or not.

bool DM_Visible();

Returns: bool

Inherited members

• From IDMObject: DM_CalculateParameterValue, DM_CurrentSheetInstanceNumber, DM_FullCrossProbeString, DM_GeneralField, DM_GetVCSProject, DM_ImageIndex, DM_IsFormulaString, DM_IsInferredObject, DM_LocationString, DM_LocationX, DM_LocationY, DM_LongDescriptorString, DM_NetIndex_Flat, DM_NetIndex_Sheet, DM_NetIndex_SubNet, DM_ObjectKindString, DM_ObjectKindStringForCrossProbe, DM_OwnerDocument, DM_OwnerDocumentFullPath, DM_OwnerDocumentName, DM_ParameterCount, DM_Parameters, DM_PcbHandle, DM_PCBObjectHandle, DM_PCBObjectInterface, DM_PrimaryCrossProbeString, DM_SchHandle, DM_SCHObjectHandle, DM_SCHObjectInterface, DM_SecondaryCrossProbeString, DM_SetVCSProject, DM_SheetIndex_Logical, DM_SheetIndex_Physical, DM_ShortDescriptorString, DM_ValidForNavigation, DM_VHDLEntity

Returned by

IDMObject.DM_Parameters, IProject.DM_ManagedParameters

Accepted by

IDMObject.DM_CalculateParameterValue