IPart interface

The IPart interface is the interface of an existing schematic part on a Schematic sheet. A part object is "part" of a component, that is, a multi-part component consists of part objects. For example a multiple gate integrated circuit has duplicate gates, and that a component represents the multi-part gate and a part represents the gate itself.

public interface IPart : IDMObject

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IDMObject

Derived: IComponent

Remarks

An equivalent component object representation is the ISch_Component class in Schematic API. The ISch_Component interface represents a component that can contain links to different model implementations such as PCB, Signal Integrity and Simulation models. Only one model of a particular model type (PCB footprint, SIM, SI, EDIF Macro and VHDL) can be enabled as the currently linked model, at any one time.

Methods

Method	Returns	Description
DM_AddConfigurationParameters	void	The method adds configuration parameters to this part object.
DM_AssignedDesignator	string	The method denotes the assigned designator for this part which is equivalent to the DM_CalculatedDesignator method.
DM_CalculatedDesignator	string	The method denotes the system compiled designator for this part.
DM_CenterLocationX	int	The method returns the central location X of the designator associated with this component.
DM_CenterLocationY	int	The method returns the central location Y of the designator associated with this component.
DM_ChannelOffset	int	The offset represents which part is offset in relation to the reference channel and the associated channels are also affected.
DM_ChildProjectSheet	IDocument	The method denotes the IDocument interface representing the child project sheet associated with this part.
DM_ChildVHDLEntity	string	The method returns the Child VHDL entity string representing the VHDL document that the part (component) is linked to.
DM_Comment	string	The method denotes the comment string for this part.
DM_ComponentKind	TComponentKind	The method denotes the component kind that this part is represented as.
DM_ConfigurationParameters	string
DM_ConfiguratorName	string
DM_CurrentImplementation	IComponentImplementation	The method returns the current implementation which is usually a PCB footprint.
DM_Description	string	The method denotes the description of the reference link to a source component or as a device name.
DM_DesignatorLocationX	int	The method returns the location X of the designator associated with this component.
DM_DesignatorLocationY	int	The method returns the location Y of the designator associated with this component.
DM_DesignatorLocked	bool	The method denotes whether or not the designator string is locked (unmoveable).
DM_DisplayMode	byte	The method Denotes one of the 255 display modes.
DM_FirstPinLocationX	int	The method denotes the reference X location of the first pin of a part object.
DM_FirstPinLocationY	int	The method denotes the reference Y location of the first pin of a part object.
DM_Footprint	string	The method denotes the footprint string that this part is associated with.
DM_FullLogicalDesignator	string	The method denotes the full logical designator which includes the part designator and part id information.
DM_FullLogicalDesignatorForDisplay	string
DM_FullPhysicalDesignator	string	The method denotes the full physical designator of a part which includes the calculated designator and the part id information on compiled schematic sheets.
DM_FullPhysicalDesignatorForDisplay	string
DM_Height	int	The method denotes the height property of the part object.
DM_ImplementationCount	int	The method returns the number of implementations of this schematic component.
DM_Implementations	IComponentImplementation	The method returns the particular IComponentImplementation for the specified indexed implementations of a Schematic component.
DM_InstanceCount	int	The method returns the number of instances of this part.
DM_Layer	string	The method denotes which layer this part is on.
DM_LibraryReference	string	The method denotes the name of the component from the library
DM_LogicalDesignator	string	The method denotes the logical designator of this part on a schematic sheet.
DM_LogicalOwnerDocument	IDocument	The method denotes the IDocument representing the logical owner document that this part is associated to a schematic component.
DM_MaxPartCount	int	The method returns the maximum part count for this part object.
DM_NewDesignator	string	The method denotes the new designator for this part.
DM_NewPartId	int	The method denotes the new part id for this part.
DM_PartID	int	The method denotes the PartID for this part.
DM_PartIdLocked	bool	The method denotes whether or not the part id string is locked (unmoveable).
DM_PartType	string	The method denotes the part type for this part.
DM_PhysicalDesignator	string	The method denotes the physical designator string of a part.
DM_PinCount	int	The method returns the number of pins for this schematic component.
DM_Pins	INetItem	The method returns the INetItem interface for the specified indexed Pin of a Schematic Component.
DM_ReferenceLocationX	int	The method returns the reference location X of the designator associated with this component.
DM_ReferenceLocationY	int	The method returns the reference location Y of the designator associated with this component.
DM_Rotation	double	The method denotes the rotation property of a part (orientation) in degrees.
DM_SetExternalPartHandle	void
DM_SourceDesignator	string	The method denotes the current designator of the source component from the corresponding schematic.
DM_SourceHierarchicalPath	string	The method denotes the source reference path to the PCB component.
DM_SourceLibraryName	string	The method denotes the name of the source library where the schematic component and its associated part come from.
DM_SourceUniqueId	string	Unique IDs (UIDs) are used to match each schematic component to the corresponding PCB component.
DM_SubProject	string	The method returns the sub project string of this part.
DM_UniqueId	string	The method returns the Unique ID string for this component so this component can be synchronized on the source document and the primary implementation document (PCB).
DM_UniqueIdName	string	The method returns the unique name portion of the Unique ID for this component.
DM_UniqueIdPath	string	The method returns the unique path portion of the Unique ID for this component.

DM_AddConfigurationParameters

The method adds configuration parameters to this part object.

void DM_AddConfigurationParameters();

Returns: nothing (void)

DM_AssignedDesignator

The method denotes the assigned designator for this part which is equivalent to the DM_CalculatedDesignator method. The DM_AssignedDesignator method returns a string that contains the designator and multi channel information but does not include multi part id information.

string DM_AssignedDesignator();

Returns: string

This method returns the calculated designator string which contains the hierarchical path and the logical designator strings. Only when a project is compiled and up to date, designators of parts are calculated based on the compiled documents they are on.

See also: IPart.DM_CalculatedDesignator

DM_CalculatedDesignator

The method denotes the system compiled designator for this part. The assigned designator for this part is equivalent to the DM_CalculatedDesignator method. A DM_CalculatedDesignator method returns a string that contains the designator and multi channel information but does not include multi part information.

string DM_CalculatedDesignator();

Returns: string

This method returns the calculated designator string which contains the hierarchical path and the logical designator strings. Only when a project is compiled and up to date, designators of parts are calculated based on the compiled documents they are on.

DM_CenterLocationX

The method returns the central location X of the designator associated with this component.

int DM_CenterLocationX();

Returns: int

DM_CenterLocationY

The method returns the central location Y of the designator associated with this component.

int DM_CenterLocationY();

Returns: int

DM_ChannelOffset

The offset represents which part is offset in relation to the reference channel and the associated channels are also affected. The method returns the ChannelOffset value.

int DM_ChannelOffset();

Returns: int

DM_ChildProjectSheet

The method denotes the IDocument interface representing the child project sheet associated with this part.

IDocument DM_ChildProjectSheet();

Returns: IDocument

Extension method of IPartHelper (using EDP;).

DM_ChildVHDLEntity

The method returns the Child VHDL entity string representing the VHDL document that the part (component) is linked to.

string DM_ChildVHDLEntity();

Returns: string

DM_Comment

The method denotes the comment string for this part.

string DM_Comment();

Returns: string

DM_ComponentKind

The method denotes the component kind that this part is represented as. in the BOM and are maintained during synchronization.

TComponentKind DM_ComponentKind();

Returns: TComponentKind

Extension method of IPartHelper (using EDP;).

A component kind can be one of the following:

eComponentKind_Standard : These components possess standard electrical properties, are always synchronized and are the type most commonly used on a board.

eComponentKind_Mechanical: These components do not have electrical properties and will appear in the BOM. They are synchronized if the same components exist on both the Schematic and PCB documents. An example is a heatsink.

eComponentKind_Graphical: These components are not used during synchronization or checked for electrical errors. These components are used, for example, when adding company logos to documents.

eComponentKind_NetTie_BOM: These components short two or more different nets for routing and these components will appear.

eComponentKind_NetTie_NoBOM: These components short two or more different nets for routing and these components will NOT appear in the BOM and are maintained during synchronization.

unit.

See also: TComponentKind

Examples: Extension_BOMManager

DM_ConfigurationParameters

No description yet.

string DM_ConfigurationParameters();

Returns: string

DM_ConfiguratorName

No description yet.

string DM_ConfiguratorName();

Returns: string

DM_CurrentImplementation

The method returns the current implementation which is usually a PCB footprint.

IComponentImplementation DM_CurrentImplementation(string argType);

Parameter	Type	Passing
argType	string	value

Returns: IComponentImplementation

Extension method of IPartHelper (using EDP;).

See also: IComponentImplementation

DM_Description

The method denotes the description of the reference link to a source component or as a device name.

string DM_Description();

Returns: string

DM_DesignatorLocationX

The method returns the location X of the designator associated with this component.

int DM_DesignatorLocationX();

Returns: int

DM_DesignatorLocationY

The method returns the location Y of the designator associated with this component.

int DM_DesignatorLocationY();

Returns: int

DM_DesignatorLocked

The method denotes whether or not the designator string is locked (unmoveable).

bool DM_DesignatorLocked();

Returns: bool

DM_DisplayMode

The method Denotes one of the 255 display modes. The mode 0 is the normal graphical display for this part object. The other 254 modes are alternative graphical displays of this same part object.

byte DM_DisplayMode();

Returns: byte

DM_FirstPinLocationX

The method denotes the reference X location of the first pin of a part object.

int DM_FirstPinLocationX();

Returns: int

DM_FirstPinLocationY

The method denotes the reference Y location of the first pin of a part object.

int DM_FirstPinLocationY();

Returns: int

DM_Footprint

The method denotes the footprint string that this part is associated with.

string DM_Footprint();

Returns: string

DM_FullLogicalDesignator

The method denotes the full logical designator which includes the part designator and part id information.

string DM_FullLogicalDesignator();

Returns: string

DM_FullLogicalDesignatorForDisplay

No description yet.

string DM_FullLogicalDesignatorForDisplay();

Returns: string

DM_FullPhysicalDesignator

The method denotes the full physical designator of a part which includes the calculated designator and the part id information on compiled schematic sheets.

string DM_FullPhysicalDesignator();

Returns: string

DM_FullPhysicalDesignatorForDisplay

No description yet.

string DM_FullPhysicalDesignatorForDisplay();

Returns: string

DM_Height

The method denotes the height property of the part object. A part object is "part" of a multi-part component.

int DM_Height();

Returns: int

DM_ImplementationCount

The method returns the number of implementations of this schematic component.

int DM_ImplementationCount();

Returns: int

Examples: Extension_PartComment

DM_Implementations

The method returns the particular IComponentImplementation for the specified indexed implementations of a Schematic component.

IComponentImplementation DM_Implementations(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IComponentImplementation

Extension method of IPartHelper (using EDP;).

Examples: Extension_PartComment

DM_InstanceCount

The method returns the number of instances of this part.

int DM_InstanceCount();

Returns: int

DM_Layer

The method denotes which layer this part is on.

string DM_Layer();

Returns: string

DM_LibraryReference

The method denotes the name of the component from the library

string DM_LibraryReference();

Returns: string

Examples: Extension_PartComment

DM_LogicalDesignator

The method denotes the logical designator of this part on a schematic sheet.

string DM_LogicalDesignator();

Returns: string

Examples: Extension_PartComment

DM_LogicalOwnerDocument

The method denotes the IDocument representing the logical owner document that this part is associated to a schematic component.

IDocument DM_LogicalOwnerDocument();

Returns: IDocument

Extension method of IPartHelper (using EDP;).

DM_MaxPartCount

The method returns the maximum part count for this part object.

int DM_MaxPartCount();

Returns: int

DM_NewDesignator

The method denotes the new designator for this part.

string DM_NewDesignator();

Returns: string

DM_NewPartId

The method denotes the new part id for this part.

int DM_NewPartId();

Returns: int

DM_PartID

The method denotes the PartID for this part. A multi-part component references each part by its PartID, for example a four part component has four unique PartIDs.

int DM_PartID();

Returns: int

DM_PartIdLocked

The method denotes whether or not the part id string is locked (unmoveable).

bool DM_PartIdLocked();

Returns: bool

DM_PartType

The method denotes the part type for this part. (Footprint type).

string DM_PartType();

Returns: string

Examples: Extension_PartComment

DM_PhysicalDesignator

The method denotes the physical designator string of a part. Note, a logical designator doesn't include the channel instance string.

string DM_PhysicalDesignator();

Returns: string

Examples: Extension_BOMManager, Extension_HierarchicalDesign

DM_PinCount

The method returns the number of pins for this schematic component.

int DM_PinCount();

Returns: int

DM_Pins

The method returns the INetItem interface for the specified indexed Pin of a Schematic Component.

INetItem DM_Pins(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetItem

Extension method of IPartHelper (using EDP;).

DM_ReferenceLocationX

The method returns the reference location X of the designator associated with this component.

int DM_ReferenceLocationX();

Returns: int

DM_ReferenceLocationY

The method returns the reference location Y of the designator associated with this component.

int DM_ReferenceLocationY();

Returns: int

DM_Rotation

The method denotes the rotation property of a part (orientation) in degrees.

double DM_Rotation();

Returns: double

DM_SetExternalPartHandle

No description yet.

void DM_SetExternalPartHandle(string argPCBComponentHandle);

Parameter	Type	Passing
argPCBComponentHandle	string	value

Returns: nothing (void)

DM_SourceDesignator

The method denotes the current designator of the source component from the corresponding schematic.

string DM_SourceDesignator();

Returns: string

DM_SourceHierarchicalPath

The method denotes the source reference path to the PCB component. The path can be multi level depending on whether it is a multi channel or a bormal design. When a schematic is transferred to a blank PCB using the Update command, the source reference links for each PCB footprint is populated with source library path names.

string DM_SourceHierarchicalPath();

Returns: string

DM_SourceLibraryName

The method denotes the name of the source library where the schematic component and its associated part come from.

string DM_SourceLibraryName();

Returns: string

Examples: Extension_PartComment

DM_SourceUniqueId

Unique IDs (UIDs) are used to match each schematic component to the corresponding PCB component. When a schematic is transferred to a blank PCB using the Update command, the source reference links for each PCB footprint is populated with source library pathnames. The UID is a system generated value that uniquely identifies the source component.

string DM_SourceUniqueId();

Returns: string

The method returns the UniqueID for this part.

DM_SubProject

The method returns the sub project string of this part. A part can represent a schematic sheet, like a sheet symbol.

string DM_SubProject();

Returns: string

DM_UniqueId

The method returns the Unique ID string for this component so this component can be synchronized on the source document and the primary implementation document (PCB).

string DM_UniqueId();

Returns: string

The method denotes the Unique ID for this part. Unique IDs are used in Schematic - PCB documents synchronization so that Sch components and its corresponding PCB components are in sync.

See also: IComponent

Examples: Extension_AddVariant, Extension_BOMManager, Extension_CreateVariantComponent

DM_UniqueIdName

The method returns the unique name portion of the Unique ID for this component.

string DM_UniqueIdName();

Returns: string

The method denotes the Unique ID name of this part.

See also: IComponent

DM_UniqueIdPath

The method returns the unique path portion of the Unique ID for this component. Includes the back slash.

string DM_UniqueIdPath();

Returns: string

The method denotes the Unique ID path of this part (includes the back slash).

See also: IComponent

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

IComponent.DM_SubParts, IComponentImplementation.DM_Part, IDocument.DM_Parts, IDocument.DM_UniqueParts, IInstance.DM_Part, INetItem.DM_Part

Accepted by

IHighlightedDocument.HL_Register_Part, IProjectProperties.DM_DesignatorRecord_ECOAnnotatePhysicalComponent, IComponentConfigurator.GetParametersFromPart, IComponentConfigurator.IsChildCoreUsedByPart

Examples

Used in the SDK examples: Extension_PartComment.