IProjectVariant interface

The IProjectVariation interface represents the project that contains component variations. Physically, there is only one PCB document with components that are specified. So for each output requirement, each document variant is generated, although there is only one PCB design document.

public interface IProjectVariant : IDMObject

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IDMObject

Methods

Method	Returns	Description
DM_AddComponentVariation	IComponentVariation
DM_AddParameter	void
DM_Description	string	Returns the description of this variant.
DM_FindComponentVariationByDesignator	IComponentVariation
DM_FindComponentVariationByUniqueId	IComponentVariation
DM_Name	string	Returns the name of this variant.
DM_OverwritePCBFootprint	bool
DM_Project	IProject	Returns the IProject interface this variant is associated with.
DM_RemoveComponentVariation	void
DM_SetDescription	void
DM_SetName	void
DM_UniqueId	string
DM_VariationCount	int	Returns the count of variants.
DM_Variations	IComponentVariation	Returns the indexed component variation for this project.

DM_AddComponentVariation

No description yet.

IComponentVariation DM_AddComponentVariation();

Returns: IComponentVariation

Extension method of IProjectVariantHelper (using EDP;).

Examples: Extension_AddVariant, Extension_CreateVariantComponent

DM_AddParameter

No description yet.

void DM_AddParameter(string argName, string argValue);

Parameter	Type	Passing
argName	string	value
argValue	string	value

Returns: nothing (void)

DM_Description

Returns the description of this variant.

string DM_Description();

Returns: string

Examples: Extension_GenerateGerber

DM_FindComponentVariationByDesignator

No description yet.

IComponentVariation DM_FindComponentVariationByDesignator(string argDesignator);

Parameter	Type	Passing
argDesignator	string	value

Returns: IComponentVariation

Extension method of IProjectVariantHelper (using EDP;).

DM_FindComponentVariationByUniqueId

No description yet.

IComponentVariation DM_FindComponentVariationByUniqueId(string argUniqueId);

Parameter	Type	Passing
argUniqueId	string	value

Returns: IComponentVariation

Extension method of IProjectVariantHelper (using EDP;).

Examples: Extension_AddVariant, Extension_CreateVariantComponent

DM_Name

Returns the name of this variant.

string DM_Name();

Returns: string

DM_OverwritePCBFootprint

No description yet.

bool DM_OverwritePCBFootprint();

Returns: bool

DM_Project

Returns the IProject interface this variant is associated with.

IProject DM_Project();

Returns: IProject

Extension method of IProjectVariantHelper (using EDP;).

DM_RemoveComponentVariation

No description yet.

void DM_RemoveComponentVariation(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: nothing (void)

DM_SetDescription

No description yet.

void DM_SetDescription(string argValue);

Parameter	Type	Passing
argValue	string	value

Returns: nothing (void)

Examples: Extension_AddVariant, Extension_CreateVariantComponent

DM_SetName

No description yet.

void DM_SetName(string argValue);

Parameter	Type	Passing
argValue	string	value

Returns: nothing (void)

Examples: Extension_AddVariant, Extension_CreateVariantComponent

DM_UniqueId

No description yet.

string DM_UniqueId();

Returns: string

DM_VariationCount

Returns the count of variants. To be used in conjunction with the DM_Variations(index) method.

int DM_VariationCount();

Returns: int

DM_Variations

Returns the indexed component variation for this project. To be used in conjunction with the DM_VariationCount method.

IComponentVariation DM_Variations(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IComponentVariation

Extension method of IProjectVariantHelper (using EDP;).

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

IComponentVariation.DM_ProjectVariant, IProject.DM_AddProjectVariant, IProject.DM_CurrentProjectVariant, IProject.DM_ProjectVariants

Accepted by

IProject.DM_SetCurrentProjectVariant, IPCB_DocumentPainterView.SetVariant

Examples

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