IDMObject interface

The IDMObject interface is the base object interface for all object interfaces used in the Work Space Manager system extension server for Altium Designer.

public interface IDMObject

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Derived: IBaseConfiguration, IBlanket, IBus, IComponentImplementation, IComponentMappings, IComponentVariation, IConstraint, IConstraintGroup, IDM_FSMState, IDM_FSMTransition, IDeviceSheetFolder, IDocument, IInstance, ILine, INet, INetItem, IObjectClass, IObjectClassCluster, IOutputJob, IOutputMedium, IOutputer, IParameter, IParameterVariation, IPart, IPartProperties, IProject, IProjectProperties, IProjectVariant, IRoom, IRule, ISearchPath, ISheetSymbol, ISignal, ISignalLink, ISignalManager, ISignalNode, ISubNet, ITextFrame, IVHDLEntity, IViolation, IWorkspace, IWrapper

Methods

Method	Returns	Description
DM_CalculateParameterValue	string
DM_CurrentSheetInstanceNumber	int	The method returns the current sheet instance number of the schematic document.
DM_FullCrossProbeString	string	The method returns the full cross probe string.
DM_GeneralField	int	The method can returns an integral value for this general field.
DM_GetVCSProject	object
DM_ImageIndex	int	The method returns the image index depending on what type of object the image represents.
DM_IsFormulaString	bool
DM_IsInferredObject	bool	The method denotes whether the object is an inferred object with respect to connective objects.
DM_LocationString	string	The method returns the Location string formatted as a X,Y format or if the object kind is a Text Documnt set, then the string returned is a formatted Line: LocationY Offset: XLocation string.
DM_LocationX	int	The method returns the location of this interface object on the X axis.
DM_LocationY	int	The method returns the location of this interface object on the Y axis.
DM_LongDescriptorString	string	The method returns the long description version string.
DM_NetIndex_Flat	int	The method returns the net index for a flattened design.
DM_NetIndex_Sheet	int	The method returns the netindex for a schematic sheet.
DM_NetIndex_SubNet	int	The method returns the net index within a sub net.
DM_ObjectKindString	string	The method returns the object kind string which denotes the design document type.
DM_ObjectKindStringForCrossProbe	string	The method returns the specially formatted object kind string for the cross probing mechanism.
DM_OwnerDocument	IDocument	The method returns the document interface object.
DM_OwnerDocumentFullPath	string	The method returns the full path of the document.
DM_OwnerDocumentName	string	The method returns the name of the document that this object interface is part of.
DM_ParameterCount	int	The method returns the number of parameters this object has.
DM_Parameters	IParameter	Returns the indexed parameter object.
DM_PcbHandle	string
DM_PCBObjectHandle	int	The method returns the object handle of a PCB object.
DM_PCBObjectInterface	object
DM_PrimaryCrossProbeString	string	The method returns the primary cross probe string.
DM_SchHandle	string
DM_SCHObjectHandle	int	The method returns the object handle of a Schematic object.
DM_SCHObjectInterface	object
DM_SecondaryCrossProbeString	string	The method returns the secondary cross probe string.
DM_SetVCSProject	void
DM_SheetIndex_Logical	int	The method returns the sheet index for a logical design (multi - channel designs for example).
DM_SheetIndex_Physical	int	The method returns the sheet index for a physical design.
DM_ShortDescriptorString	string	The method returns the short description version string.
DM_ValidForNavigation	bool	The method toggles whether navigation is valid for this object.
DM_VHDLEntity	IVHDLEntity	The method returns the VHDL entity interface object if it exists on a VHDL document.

DM_CalculateParameterValue

No description yet.

string DM_CalculateParameterValue(IParameter argParameter);
string DM_CalculateParameterValue(object argParameter);

Parameter	Type	Passing
argParameter	IParameter	value

Returns: string

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

DM_CurrentSheetInstanceNumber

The method returns the current sheet instance number of the schematic document.

int DM_CurrentSheetInstanceNumber();

Returns: int

DM_FullCrossProbeString

The method returns the full cross probe string.

string DM_FullCrossProbeString();

Returns: string

DM_GeneralField

The method can returns an integral value for this general field. This General Field can be used for any purpose - as a tag property, as an index property or as a flag to denote something.

int DM_GeneralField();

Returns: int

DM_GetVCSProject

No description yet.

object DM_GetVCSProject();

Returns: object

DM_ImageIndex

The method returns the image index depending on what type of object the image represents.

int DM_ImageIndex();

Returns: int

DM_IsFormulaString

No description yet.

bool DM_IsFormulaString(string argFormula);

Parameter	Type	Passing
argFormula	string	value

Returns: bool

DM_IsInferredObject

The method denotes whether the object is an inferred object with respect to connective objects. Bus and Sheet Symbols can be defined in ranges using the NetLabel [] and Repeat statements respectively and once the project has been compiled, inferred objects are created in memory for navigation/connective purposes. For example, a Bus with a range of A0..4 ends up with five wires with A0...A5 net labels (only in memory). This property is useful for multi - channel projects and for sheets that have Bus objects.

bool DM_IsInferredObject();

Returns: bool

Examples: Extension_CreateVariantComponent

DM_LocationString

The method returns the Location string formatted as a X,Y format or if the object kind is a Text Documnt set, then the string returned is a formatted Line: LocationY Offset: XLocation string.

string DM_LocationString();

Returns: string

DM_LocationX

The method returns the location of this interface object on the X axis.

int DM_LocationX();

Returns: int

DM_LocationY

The method returns the location of this interface object on the Y axis.

int DM_LocationY();

Returns: int

DM_LongDescriptorString

The method returns the long description version string.

string DM_LongDescriptorString();

Returns: string

DM_NetIndex_Flat

The method returns the net index for a flattened design.

int DM_NetIndex_Flat();

Returns: int

DM_NetIndex_Sheet

The method returns the netindex for a schematic sheet.

int DM_NetIndex_Sheet();

Returns: int

DM_NetIndex_SubNet

The method returns the net index within a sub net.

int DM_NetIndex_SubNet();

Returns: int

DM_ObjectKindString

The method returns the object kind string which denotes the design document type.

string DM_ObjectKindString();

Returns: string

Examples: Ciiva

DM_ObjectKindStringForCrossProbe

The method returns the specially formatted object kind string for the cross probing mechanism.

string DM_ObjectKindStringForCrossProbe();

Returns: string

DM_OwnerDocument

The method returns the document interface object. Refer to IDocument interface for details.

IDocument DM_OwnerDocument();

Returns: IDocument

Extension method of IDMObjectHelper (using EDP;).

DM_OwnerDocumentFullPath

The method returns the full path of the document.

string DM_OwnerDocumentFullPath();

Returns: string

DM_OwnerDocumentName

The method returns the name of the document that this object interface is part of.

string DM_OwnerDocumentName();

Returns: string

DM_ParameterCount

The method returns the number of parameters this object has.

int DM_ParameterCount();

Returns: int

Examples: Extension_AddVariant, Extension_BOMManager, Extension_PartComment

DM_Parameters

Returns the indexed parameter object. Use the IParameter interface to wrap the returned result.

IParameter DM_Parameters(int argIndex);

Parameter	Type	Passing	Description
argIndex	int	value	The index of the parameter object.

Returns: IParameter

Extension method of IDMObjectHelper (using EDP;).

Examples: Extension_AddVariant, Extension_BOMManager, Extension_PartComment, Extension_RefreshDocument

DM_PcbHandle

No description yet.

string DM_PcbHandle();

Returns: string

DM_PCBObjectHandle

The method returns the object handle of a PCB object. If void, a null value is returned.

int DM_PCBObjectHandle();

Returns: int

DM_PCBObjectInterface

No description yet.

object DM_PCBObjectInterface();

Returns: object

DM_PrimaryCrossProbeString

The method returns the primary cross probe string.

string DM_PrimaryCrossProbeString();

Returns: string

DM_SchHandle

No description yet.

string DM_SchHandle();

Returns: string

Examples: Extension_TestPortHarnessDev

DM_SCHObjectHandle

The method returns the object handle of a Schematic object. If void, a zero value is returned.

int DM_SCHObjectHandle();

Returns: int

DM_SCHObjectInterface

No description yet.

object DM_SCHObjectInterface();

Returns: object

DM_SecondaryCrossProbeString

The method returns the secondary cross probe string.

string DM_SecondaryCrossProbeString();

Returns: string

DM_SetVCSProject

No description yet.

void DM_SetVCSProject(object argValue);

Parameter	Type	Passing
argValue	object	value

Returns: nothing (void)

DM_SheetIndex_Logical

The method returns the sheet index for a logical design (multi - channel designs for example).

int DM_SheetIndex_Logical();

Returns: int

DM_SheetIndex_Physical

The method returns the sheet index for a physical design. (that have unique designators)

int DM_SheetIndex_Physical();

Returns: int

DM_ShortDescriptorString

The method returns the short description version string.

string DM_ShortDescriptorString();

Returns: string

DM_ValidForNavigation

The method toggles whether navigation is valid for this object. Navigation is performed on net aware objects such as components, nets and busses.

bool DM_ValidForNavigation();

Returns: bool

DM_VHDLEntity

The method returns the VHDL entity interface object if it exists on a VHDL document. Basically every object interface has an access to this VHDL entity interface, so to check whether VHDL entity exists for this particular object, you can check out the Name field within the IVHDLEntity interface.

IVHDLEntity DM_VHDLEntity();

Returns: IVHDLEntity

Extension method of IDMObjectHelper (using EDP;).

See also: IDMObject.DM_GetVCSProject

Returned by

IHighlightedDocument.HL_GetLinkedObject, IHighlightedDocument.HL_Objects, IParameter.DM_OriginalOwner, IViolation.DM_RelatedObjects

Accepted by

IECO.DM_AddMemberToObject, IECO.DM_AddObject, IECO.DM_ChangeObject, IECO.DM_RemoveMemberFromObject, IECO.DM_RemoveObject, IHighlightedDocument.HL_ChooseObjectGraphically, IHighlightedDocument.HL_GetLinkedObject, IHighlightedDocument.HL_Register_DMObject, IHighlightedDocument.HL_UnRegister_Object, IHighlightedDocument.HL_XProbeChooseObject, IViolation.DM_AddRelatedObject, IWorkspace.DM_DisplayNavigationHint, IWorkspace.DM_NotifyObjectNavigated, IWorkspace.DM_NotifyObjectsNavigated, ISch_ServerInterface.UpdateSignalValueDisplay