IComponentVariation interface

The IComponentVariation interface represents the component variant on a PCB document. There is only one physical document, but each component on this document can be specified to be a variant and when the output is generated, a specific variant document is generated. This variant output is controlled by the Output Job files.

public interface IComponentVariation : IDMObject

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IDMObject

Methods

Method	Returns	Description
DM_AddParameterVariation	IParameterVariation
DM_AlternateLibraryLink	IComponentLibraryLink
DM_AlternatePart	string	Returns the alternate part string for this component variant.
DM_CalculatedAlternatePart	string
DM_EditAlternateLibraryLink	bool
DM_EditAlternateLibraryLink_1	bool
DM_FindParameterVariation	IParameterVariation
DM_PhysicalDesignator	string	Returns the full physical designator string for this component variant.
DM_ProjectVariant	IProjectVariant	This method returns the IProjectVariant interface which represents a container that stores the component variants for the project.
DM_RemoveParameterVariation	void
DM_SetAlternatePart	void
DM_SetPhysicalDesignator	void
DM_SetUniqueId	void
DM_SetVariationKind	void
DM_UniqueId	string	Returns the unique ID for this component variant.
DM_VariationCount	int	Returns the number of variations.
DM_VariationKind	TVariationKind	This method returns the variation kind for this component.
DM_Variations	IParameterVariation	Returns the indexed parameter variation for this component variation.

DM_AddParameterVariation

No description yet.

IParameterVariation DM_AddParameterVariation();

Returns: IParameterVariation

Extension method of IComponentVariationHelper (using EDP;).

Examples: Extension_AddVariant

DM_AlternateLibraryLink

No description yet.

IComponentLibraryLink DM_AlternateLibraryLink();

Returns: IComponentLibraryLink

Extension method of IComponentVariationHelper (using EDP;).

Examples: Extension_CreateVariantComponent

DM_AlternatePart

Returns the alternate part string for this component variant.

string DM_AlternatePart();

Returns: string

DM_CalculatedAlternatePart

No description yet.

string DM_CalculatedAlternatePart(IComponent argComponent);
string DM_CalculatedAlternatePart(object argComponent);

Parameter	Type	Passing
argComponent	IComponent	value

Returns: string

The first overload is an extension method of IComponentVariationHelper (using EDP;) with typed parameters; the second is declared by the interface.

DM_EditAlternateLibraryLink

No description yet.

bool DM_EditAlternateLibraryLink(object argSchComponent);

Parameter	Type	Passing
argSchComponent	object	value

Returns: bool

DM_EditAlternateLibraryLink_1

No description yet.

bool DM_EditAlternateLibraryLink_1(object argSchComponent, object argComponent);

Parameter	Type	Passing
argSchComponent	object	value
argComponent	object	value

Returns: bool

DM_FindParameterVariation

No description yet.

IParameterVariation DM_FindParameterVariation(string argName);

Parameter	Type	Passing
argName	string	value

Returns: IParameterVariation

Extension method of IComponentVariationHelper (using EDP;).

Examples: Extension_AddVariant

DM_PhysicalDesignator

Returns the full physical designator string for this component variant.

string DM_PhysicalDesignator();

Returns: string

DM_ProjectVariant

This method returns the IProjectVariant interface which represents a container that stores the component variants for the project.

IProjectVariant DM_ProjectVariant();

Returns: IProjectVariant

Extension method of IComponentVariationHelper (using EDP;).

DM_RemoveParameterVariation

No description yet.

void DM_RemoveParameterVariation(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: nothing (void)

DM_SetAlternatePart

No description yet.

void DM_SetAlternatePart(string argValue);

Parameter	Type	Passing
argValue	string	value

Returns: nothing (void)

DM_SetPhysicalDesignator

No description yet.

void DM_SetPhysicalDesignator(string argValue);

Parameter	Type	Passing
argValue	string	value

Returns: nothing (void)

DM_SetUniqueId

No description yet.

void DM_SetUniqueId(string argValue);

Parameter	Type	Passing
argValue	string	value

Returns: nothing (void)

Examples: Extension_AddVariant, Extension_CreateVariantComponent

DM_SetVariationKind

No description yet.

void DM_SetVariationKind(TVariationKind argValue);
void DM_SetVariationKind(int argValue);

Parameter	Type	Passing
argValue	TVariationKind	value

Returns: nothing (void)

The first overload is an extension method of IComponentVariationHelper (using EDP;) with typed parameters; the second is declared by the interface.

Examples: Extension_AddVariant, Extension_CreateVariantComponent

DM_UniqueId

Returns the unique ID for this component variant.

string DM_UniqueId();

Returns: string

DM_VariationCount

Returns the number of variations.

int DM_VariationCount();

Returns: int

Examples: Extension_BOMManager

DM_VariationKind

This method returns the variation kind for this component.

TVariationKind DM_VariationKind();

Returns: TVariationKind

Extension method of IComponentVariationHelper (using EDP;).

Examples: Extension_BOMManager, Extension_BOMManager

DM_Variations

Returns the indexed parameter variation for this component variation.

IParameterVariation DM_Variations(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IParameterVariation

Extension method of IComponentVariationHelper (using EDP;).

Examples: Extension_BOMManager

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

IProjectVariant.DM_AddComponentVariation, IProjectVariant.DM_FindComponentVariationByDesignator, IProjectVariant.DM_FindComponentVariationByUniqueId, IProjectVariant.DM_Variations

Accepted by

IParameterVariation.DM_CalculatedValue

Examples

Used in the SDK examples: Extension_AddVariant, Extension_BOMManager, Extension_BOMManager, Extension_CreateVariantComponent.