IDocument interface

The IDocument interface represents the existing document in Altium Designer. A document can be a Schematic, PCB, VHDL, PCB Library document etc.

public interface IDocument : IDMObject

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IDMObject

Remarks

The DM_DocumentKind method of the IDocument interface when invoked returns you the document type. A document can be part of a project or free documents project.

An existing document can be queried to return the project interface this document is associated with.

The IDocument interface is a standalone interface.

Methods

Method	Returns	Description
DM_BlanketCount	int
DM_Blankets	IBlanket
DM_BusCount	int	The method returns the number of bus objects from this document.
DM_Buses	IBus	The method returns the indexed Bus instance from this document.
DM_ChannelClassCount	int	The method denotes the number of Channel Classes from this document.
DM_ChannelClasses	IChannelClass	The method returns the indexed ChannelClass instance from this document.
DM_ChannelIndex	int	The method returns the channel index of this document.
DM_ChannelPrefix	string	The method returns the channel prefix of this document.
DM_ChannelRoomNamingStyle	TChannelRoomNamingStyle	The method returns the channel room naming style value.
DM_ChildDocumentCount	int	The method returns the number of child documents relative to this document.
DM_ChildDocuments	IDocument	The method returns the indexed child document.
DM_Compile	bool	The method invokes the compiler to compile this document.
DM_ComponentClassCount	int	The method denotes the number of component classes from this document.
DM_ComponentClasses	IComponentClass	The method returns the indexed ComponentClass instance from this document.
DM_ComponentCount	int	The method returns the number of component instances on this document.
DM_Components	IComponent	The method returns the indexed component instance from this document.
DM_ConstraintGroupCount	int	The method denotes the number of constraint groups.
DM_ConstraintGroups	IConstraintGroup	The method returns the indexed constraint group.
DM_CreateViolation	IViolation	The method creates a violation based on the error kind and error string upon an incorrect design.
DM_CrossSheetConnectorCount	int	The method returns the number of cross sheet connectors on this document.
DM_CrossSheetConnectors	ICrossSheet	The method returns the indexed cross sheet connector instance from this document.
DM_CurrentInstanceNumber	int	The method returns the current instance number for this document (especially for multi-channel designs where a design document can be referenced multiple times).
DM_DifferentialPairCount	int	This method returns the number of differential pairs used in a document in the project.
DM_DifferentialPairs	IDifferentialPair	This method returns an indexed differential pair from a document in the project.
DM_DocumentID	string
DM_DocumentIsLoaded	bool	This method returns a boolean value whether this document has been loaded in Altium Designer or not.
DM_DocumentIsTextual	bool	The method denotes whether the document is a text document.
DM_DocumentKind	string	This method returns the document kind for the current document.
DM_DocumentLoaded	void
DM_FileName	string	This method returns the file name string of this document.
DM_FSMClockPort	INetItem
DM_FSMResetPort	INetItem
DM_FSMState	IDM_FSMState
DM_FSMStateCount	int
DM_FSMTransition	IDM_FSMTransition
DM_FSMTransitionCount	int
DM_FullPath	string	This method returns the full path of where this document lives.
DM_GetItemRevisionGUID	string
DM_GetNetProperties	INetProperties
DM_HarnessConnectorCount	int
DM_HarnessConnectors	ISheetSymbol
DM_HarnessNetCount	int
DM_HarnessNets	INet
DM_IndentLevel	int	The method returns the indent level for this current document with respect to the current project.
DM_IsDeviceSheet	bool
DM_IsDocumentFileLessEditing	bool
DM_IsPhysicalDocument	bool	This method returns a Boolean value whether this document is a physical document or not.
DM_IsPrimaryImplementationDocument	bool	This method returns a Boolean value whether this document is a primary implementation document (namely a PCB document for instance).
DM_IsVirtualDocument	bool
DM_LoadDocument	bool	This method returns a Boolean value whether this document has been loaded or not.
DM_LogicalDocument	IDocument	This method returns the logical document if valid.
DM_ModelKind	string	The method returns the model kind string related to this document.
DM_NeedsScrapCompile	bool
DM_NetClassCount	int	The method denotes the number of net classes on this document.
DM_NetClasses	INetClass	The method returns the indexed NetClass instance from this document.
DM_NetCount	int	The method returns the number of nets from this document.
DM_Nets	INet	The method returns an indexed net associated with this document.
DM_ParentDocumentCount	int	The method returns the number of parent documents relative to this document.
DM_ParentDocuments	IDocument	The method returns the indexed parent document.
DM_ParentSheetSymbolCount	int
DM_ParentSheetSymbols	ISheetSymbol
DM_PartCount	int	The method returns the number of part objects from this document.
DM_Parts	IPart	The method returns an indexed part associated with this document.
DM_PhysicalDocument	IDocument
DM_PhysicalDocumentCount	int	The method returns the number of physical documents associated with this document.
DM_PhysicalDocumentParent	IDocument	The method returns the IDocument interface for a parent physical document.
DM_PhysicalInstanceName	string	The method returns the name of this physical document if valid.
DM_PhysicalInstancePath	string	The method returns the path to the physical document instance if valid.
DM_PhysicalRoomName	string	The method returns the name of the room on this physical document if valid.
DM_PortCount	int	The method returns the number of port objects on this document.
DM_Ports	INetItem	The method returns the indexed port instance from this document.
DM_Project	IProject	This method returns the IProject object interface that this document is associated with.
DM_RoomCount	int	The method denotes the number of rooms on this document.
DM_Rooms	IRoom	The method returns the indexed room instance from this document.
DM_RuleCount	int	The method returns the number of rules from this document.
DM_Rules	IRule	The method denotes the indexed rule from this document.
DM_ScrapCompile	bool	The method invokes a scrap compile (by force or not).
DM_ScrapCompileWithOptions	bool
DM_ServerDocument	IServerDocument
DM_SetItemRevisionGUID	void
DM_SheetSizeX	int
DM_SheetSizey	int
DM_SheetSymbolCount	int	The method returns the number of sheet symbols from this document.
DM_SheetSymbols	ISheetSymbol	The method returns an indexed sheet symbol associated with this document.
DM_SignalManager	ISignalManager	The method returns the signal manager interface.
DM_SmartLoad	bool
DM_SpatialAnalysis	bool
DM_SpatialAnalysisForTest	int
DM_TextFrameCount	int	The method returns the number of text frame objects from this document.
DM_TextFrames	ITextFrame	The method returns an indexed textframe object associated with this document.
DM_UniqueComponentCount	int	The method returns the number of unique components according to the library (ies) they are placed from.
DM_UniqueComponents	IComponent	The method returns the indexed unique component instance from this document.
DM_UniquePartCount	int	The method denotes the number of unique parts from this document.
DM_UniqueParts	IPart	The method returns an indexed unique part associated with this document.
DM_UpdateDateModified	void	The method sets the modified date for this document.
DM_VHDLEntities	IVHDLEntity	The method returns the indexed VHDL entity instance from this document.
DM_VHDLEntityCount	int	The method denotes the number of VHDL entities from this document.

DM_BlanketCount

No description yet.

int DM_BlanketCount();

Returns: int

DM_Blankets

No description yet.

IBlanket DM_Blankets(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IBlanket

Extension method of IDocumentHelper (using EDP;).

DM_BusCount

The method returns the number of bus objects from this document. Use this in conjunction with the DM_Buses(Index) to go through each bus object.

int DM_BusCount();

Returns: int

DM_Buses

The method returns the indexed Bus instance from this document.

IBus DM_Buses(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IBus

Extension method of IDocumentHelper (using EDP;).

DM_ChannelClassCount

The method denotes the number of Channel Classes from this document. Use this Channel Class count in conjunction with the DM_ChannelClasses(index) to go through each channel class.

int DM_ChannelClassCount();

Returns: int

DM_ChannelClasses

The method returns the indexed ChannelClass instance from this document. Use this in conjunction with the DM_ChannelClassCount method

IChannelClass DM_ChannelClasses(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IChannelClass

Extension method of IDocumentHelper (using EDP;).

DM_ChannelIndex

The method returns the channel index of this document. This is especially for multi-channel designs where a single source document can be referenced multiple times.

int DM_ChannelIndex();

Returns: int

DM_ChannelPrefix

The method returns the channel prefix of this document. This is especially for multi-channel designs where a single source document can be referenced multiple times.

string DM_ChannelPrefix();

Returns: string

DM_ChannelRoomNamingStyle

The method returns the channel room naming style value.

TChannelRoomNamingStyle DM_ChannelRoomNamingStyle();

Returns: TChannelRoomNamingStyle

Extension method of IDocumentHelper (using EDP;).

DM_ChildDocumentCount

The method returns the number of child documents relative to this document.

int DM_ChildDocumentCount();

Returns: int

DM_ChildDocuments

The method returns the indexed child document. A hierarchical design consists of multi layered parent-child documents.

IDocument DM_ChildDocuments(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IDocument

Extension method of IDocumentHelper (using EDP;).

DM_Compile

The method invokes the compiler to compile this document. If the compile was successful, a true value is returned.

bool DM_Compile();

Returns: bool

DM_ComponentClassCount

The method denotes the number of component classes from this document. Use this Component class count in conjunction with the DM_ComponentClasses(index) to go through each component class.

int DM_ComponentClassCount();

Returns: int

DM_ComponentClasses

The method returns the indexed ComponentClass instance from this document. Use this in conjuniton with the DM_ComponentClassCount method.

IComponentClass DM_ComponentClasses(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IComponentClass

Extension method of IDocumentHelper (using EDP;).

DM_ComponentCount

The method returns the number of component instances on this document. Use this in conjunction with the DM_Components(Index) method to go through each component object.

int DM_ComponentCount();

Returns: int

Examples: Extension_AddVariant, Extension_BOMManager, Extension_CreateVariantComponent, Extension_HierarchicalDesign

DM_Components

The method returns the indexed component instance from this document. This is to be used in conjunction with the DM_ComponentCount method.

IComponent DM_Components(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IComponent

Extension method of IDocumentHelper (using EDP;).

Examples: Extension_AddVariant, Extension_BOMManager, Extension_CreateVariantComponent, Extension_HierarchicalDesign

DM_ConstraintGroupCount

The method denotes the number of constraint groups.

int DM_ConstraintGroupCount();

Returns: int

DM_ConstraintGroups

The method returns the indexed constraint group. Use the DM_ConstraintGroupCount method to get the number of constraint groups.

IConstraintGroup DM_ConstraintGroups(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IConstraintGroup

Extension method of IDocumentHelper (using EDP;).

DM_CreateViolation

The method creates a violation based on the error kind and error string upon an incorrect design.

IViolation DM_CreateViolation(TErrorKind argErrorKind, string argErrorString);

Parameter	Type	Passing
argErrorKind	TErrorKind	value
argErrorString	string	value

Returns: IViolation

Extension method of IDocumentHelper (using EDP;).

DM_CrossSheetConnectorCount

The method returns the number of cross sheet connectors on this document. Use this in conjunction with the DM_CrossConnectors(index) to go through each cross connector object.

int DM_CrossSheetConnectorCount();

Returns: int

DM_CrossSheetConnectors

The method returns the indexed cross sheet connector instance from this document. This is to be used in conjunction with the DM_CrossSheetConnectorCount method.

ICrossSheet DM_CrossSheetConnectors(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: ICrossSheet

Extension method of IDocumentHelper (using EDP;).

DM_CurrentInstanceNumber

The method returns the current instance number for this document (especially for multi-channel designs where a design document can be referenced multiple times).

int DM_CurrentInstanceNumber();

Returns: int

DM_DifferentialPairCount

This method returns the number of differential pairs used in a document in the project.

int DM_DifferentialPairCount();

Returns: int

See also: IDifferentialPair

DM_DifferentialPairs

This method returns an indexed differential pair from a document in the project.

IDifferentialPair DM_DifferentialPairs(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IDifferentialPair

Extension method of IDocumentHelper (using EDP;).

See also: IDifferentialPair

DM_DocumentID

No description yet.

string DM_DocumentID();

Returns: string

DM_DocumentIsLoaded

This method returns a boolean value whether this document has been loaded in Altium Designer or not.

bool DM_DocumentIsLoaded();

Returns: bool

DM_DocumentIsTextual

The method denotes whether the document is a text document.

bool DM_DocumentIsTextual();

Returns: bool

DM_DocumentKind

This method returns the document kind for the current document. A document could be a Schematic document and thus the string returned is 'SCH'. Check the installation file of each server for the Server Name.

string DM_DocumentKind();

Returns: string

Examples: Ciiva, Ciiva, Extension_PartComment

DM_DocumentLoaded

No description yet.

void DM_DocumentLoaded();

Returns: nothing (void)

DM_FileName

This method returns the file name string of this document.

string DM_FileName();

Returns: string

Examples: Ciiva

DM_FSMClockPort

No description yet.

INetItem DM_FSMClockPort();

Returns: INetItem

Extension method of IDocumentHelper (using EDP;).

DM_FSMResetPort

No description yet.

INetItem DM_FSMResetPort();

Returns: INetItem

Extension method of IDocumentHelper (using EDP;).

DM_FSMState

No description yet.

IDM_FSMState DM_FSMState(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IDM_FSMState

Extension method of IDocumentHelper (using EDP;).

DM_FSMStateCount

No description yet.

int DM_FSMStateCount();

Returns: int

DM_FSMTransition

No description yet.

IDM_FSMTransition DM_FSMTransition(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IDM_FSMTransition

Extension method of IDocumentHelper (using EDP;).

DM_FSMTransitionCount

No description yet.

int DM_FSMTransitionCount();

Returns: int

DM_FullPath

This method returns the full path of where this document lives.

string DM_FullPath();

Returns: string

Examples: Ciiva

DM_GetItemRevisionGUID

No description yet.

string DM_GetItemRevisionGUID();

Returns: string

DM_GetNetProperties

No description yet.

INetProperties DM_GetNetProperties(string argObjectHandle);

Parameter	Type	Passing
argObjectHandle	string	value

Returns: INetProperties

Extension method of IDocumentHelper (using EDP;).

DM_HarnessConnectorCount

No description yet.

int DM_HarnessConnectorCount();

Returns: int

DM_HarnessConnectors

No description yet.

ISheetSymbol DM_HarnessConnectors(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: ISheetSymbol

Extension method of IDocumentHelper (using EDP;).

DM_HarnessNetCount

No description yet.

int DM_HarnessNetCount();

Returns: int

DM_HarnessNets

No description yet.

INet DM_HarnessNets(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INet

Extension method of IDocumentHelper (using EDP;).

DM_IndentLevel

The method returns the indent level for this current document with respect to the current project.

int DM_IndentLevel();

Returns: int

DM_IsDeviceSheet

No description yet.

bool DM_IsDeviceSheet();

Returns: bool

DM_IsDocumentFileLessEditing

No description yet.

bool DM_IsDocumentFileLessEditing();

Returns: bool

DM_IsPhysicalDocument

This method returns a Boolean value whether this document is a physical document or not. There are logical and physical documents; these terms are used to differentiate the documents in multi-channel projects. A multi channel design means that a single sheet is referenced repeatedly for a channel design. This sheet is called a logical document. A physical document (usually a PCB document) has components with unique names within a room which is mapped to a channel on a Schematic sheet. So a multi channel design translates to multiple rooms with components with unique physical designators on a PCB.

bool DM_IsPhysicalDocument();

Returns: bool

A physical designator of a PCB component is calculated to have the hierarchy path of a schematic project as well as the logical designator of the associated Schematic component to ensure that this designator for the PCB component is unique.

DM_IsPrimaryImplementationDocument

This method returns a Boolean value whether this document is a primary implementation document (namely a PCB document for instance). A schematic document is a source document and is centric to a design project.

bool DM_IsPrimaryImplementationDocument();

Returns: bool

DM_IsVirtualDocument

No description yet.

bool DM_IsVirtualDocument();

Returns: bool

DM_LoadDocument

This method returns a Boolean value whether this document has been loaded or not.

bool DM_LoadDocument();

Returns: bool

DM_LogicalDocument

This method returns the logical document if valid. Otherwise a nil value is returned. There are logical and physical documents; these terms are used to differentiate the documents in multi-channel projects. A multi channel design means that a single sheet is referenced repeatedly for a channel design. This sheet is called a logical document. A physical document (usually a PCB document) has components with unique names within a room which is mapped to a channel on a Schematic sheet. So a multi channel design translates to multiple rooms with components with unique physical designators on a PCB.

IDocument DM_LogicalDocument();

Returns: IDocument

Extension method of IDocumentHelper (using EDP;).

A physical designator of a PCB component is calculated to have the hierarchy path of a schematic project as well as the logical designator of the associated Schematic component to ensure that this designator for the PCB component is unique.

DM_ModelKind

The method returns the model kind string related to this document.

string DM_ModelKind();

Returns: string

DM_NeedsScrapCompile

No description yet.

bool DM_NeedsScrapCompile();

Returns: bool

DM_NetClassCount

The method denotes the number of net classes on this document. Use this NetClass count in conjunction with the DM_NetClasses(Index) method to go through each net class.

int DM_NetClassCount();

Returns: int

DM_NetClasses

The method returns the indexed NetClass instance from this document. Use this in conjunction with the DM_NetClassCount method.

INetClass DM_NetClasses(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetClass

Extension method of IDocumentHelper (using EDP;).

DM_NetCount

The method returns the number of nets from this document. Use this Net count in conjunction with the DM_Nets(Index) to go through each sheet symbol object

int DM_NetCount();

Returns: int

DM_Nets

The method returns an indexed net associated with this document.

INet DM_Nets(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INet

Extension method of IDocumentHelper (using EDP;).

DM_ParentDocumentCount

The method returns the number of parent documents relative to this document.

int DM_ParentDocumentCount();

Returns: int

DM_ParentDocuments

The method returns the indexed parent document. A hierarchical design consists of multi layered parent-child documents.

IDocument DM_ParentDocuments(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IDocument

Extension method of IDocumentHelper (using EDP;).

DM_ParentSheetSymbolCount

No description yet.

int DM_ParentSheetSymbolCount();

Returns: int

DM_ParentSheetSymbols

No description yet.

ISheetSymbol DM_ParentSheetSymbols(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: ISheetSymbol

Extension method of IDocumentHelper (using EDP;).

DM_PartCount

The method returns the number of part objects from this document. Use this PartCount in conjunction with the DM_Parts(Index) to go through each part object.

int DM_PartCount();

Returns: int

Examples: Extension_PartComment

DM_Parts

The method returns an indexed part associated with this document.

IPart DM_Parts(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IPart

Extension method of IDocumentHelper (using EDP;).

Examples: Extension_PartComment

DM_PhysicalDocument

No description yet.

IDocument DM_PhysicalDocument(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IDocument

Extension method of IDocumentHelper (using EDP;).

DM_PhysicalDocumentCount

The method returns the number of physical documents associated with this document.

int DM_PhysicalDocumentCount();

Returns: int

DM_PhysicalDocumentParent

The method returns the IDocument interface for a parent physical document. Could be a VHDL or a PCB document for example.

IDocument DM_PhysicalDocumentParent();

Returns: IDocument

Extension method of IDocumentHelper (using EDP;).

DM_PhysicalInstanceName

The method returns the name of this physical document if valid. Otherwise an empty string is returned.

string DM_PhysicalInstanceName();

Returns: string

DM_PhysicalInstancePath

The method returns the path to the physical document instance if valid. Otherwise an empty string is returned.

string DM_PhysicalInstancePath();

Returns: string

DM_PhysicalRoomName

The method returns the name of the room on this physical document if valid. Otherwise a nil value is returned.

string DM_PhysicalRoomName();

Returns: string

DM_PortCount

The method returns the number of port objects on this document. Use this in conjunction with the DM_Ports(index) to go through each port object.

int DM_PortCount();

Returns: int

Examples: Extension_TestPortHarnessDev

DM_Ports

The method returns the indexed port instance from this document. This is to be used in conjunction with the DM_PortCount method

INetItem DM_Ports(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetItem

Extension method of IDocumentHelper (using EDP;).

Examples: Extension_TestPortHarnessDev

DM_Project

This method returns the IProject object interface that this document is associated with.

IProject DM_Project();

Returns: IProject

Extension method of IDocumentHelper (using EDP;).

Examples: Ciiva

DM_RoomCount

The method denotes the number of rooms on this document. Use this RoomCount in conjunction with the DM_Rooms(Index) to go through each room object.

int DM_RoomCount();

Returns: int

DM_Rooms

The method returns the indexed room instance from this document. Use this in conjunction with the DM_RoomCount method.

IRoom DM_Rooms(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IRoom

Extension method of IDocumentHelper (using EDP;).

DM_RuleCount

The method returns the number of rules from this document. Use this Rule count in conjunction with the DM_Rules(Index) to go through each sheet symbol object

int DM_RuleCount();

Returns: int

DM_Rules

The method denotes the indexed rule from this document. Use this DM_RuleCount in conjunction with the DM_Rules to go through each rule found from this document..

IRule DM_Rules(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IRule

Extension method of IDocumentHelper (using EDP;).

DM_ScrapCompile

The method invokes a scrap compile (by force or not). A scrap compile is the background compile in Altium Designer on a design document and does all the auto - junctions for bus and wire objects. Also the scrap compile does the online rule checks in schematics. It is totally separate from the main compile which compile projects.

bool DM_ScrapCompile(bool argForceCompile);

Parameter	Type	Passing
argForceCompile	bool	value

Returns: bool

DM_ScrapCompileWithOptions

No description yet.

bool DM_ScrapCompileWithOptions(bool argForceCompile, string argOptions);

Parameter	Type	Passing
argForceCompile	bool	value
argOptions	string	value

Returns: bool

DM_ServerDocument

No description yet.

IServerDocument DM_ServerDocument();

Returns: IServerDocument

Extension method of IDocumentHelper (using EDP;).

DM_SetItemRevisionGUID

No description yet.

void DM_SetItemRevisionGUID(string argS);

Parameter	Type	Passing
argS	string	value

Returns: nothing (void)

DM_SheetSizeX

No description yet.

int DM_SheetSizeX();

Returns: int

DM_SheetSizey

No description yet.

int DM_SheetSizey();

Returns: int

DM_SheetSymbolCount

The method returns the number of sheet symbols from this document. Use this SheetSymbol count in conjunction with the DM_SheetSymbols(Index) to go through each sheet symbol object.

int DM_SheetSymbolCount();

Returns: int

DM_SheetSymbols

The method returns an indexed sheet symbol associated with this document.

ISheetSymbol DM_SheetSymbols(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: ISheetSymbol

Extension method of IDocumentHelper (using EDP;).

DM_SignalManager

The method returns the signal manager interface.

ISignalManager DM_SignalManager();

Returns: ISignalManager

Extension method of IDocumentHelper (using EDP;).

See also: ISignalManager

DM_SmartLoad

No description yet.

bool DM_SmartLoad();

Returns: bool

DM_SpatialAnalysis

No description yet.

bool DM_SpatialAnalysis(bool argForce, bool argllowAbort, bool argbortOnMouseMove);

Parameter	Type	Passing
argForce	bool	value
argllowAbort	bool	value
argbortOnMouseMove	bool	value

Returns: bool

DM_SpatialAnalysisForTest

No description yet.

int DM_SpatialAnalysisForTest();

Returns: int

DM_TextFrameCount

The method returns the number of text frame objects from this document. Use this TextFrame count in conjunction with the DM_TextFrames(Index) to go through each sheet symbol object

int DM_TextFrameCount();

Returns: int

DM_TextFrames

The method returns an indexed textframe object associated with this document.

ITextFrame DM_TextFrames(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: ITextFrame

Extension method of IDocumentHelper (using EDP;).

DM_UniqueComponentCount

The method returns the number of unique components according to the library (ies) they are placed from. A duplicate of components of the same component kind is counted as one (1). Use this in conjunction with the DM_UniqueComponents(Index) method to go through each unique component object.

int DM_UniqueComponentCount();

Returns: int

DM_UniqueComponents

The method returns the indexed unique component instance from this document. This method is to be used in conjunction with the DM_UniqueComponentCount method.

IComponent DM_UniqueComponents(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IComponent

Extension method of IDocumentHelper (using EDP;).

DM_UniquePartCount

The method denotes the number of unique parts from this document. Duplicates of the same part kind are only returned as a count of one (1).

int DM_UniquePartCount();

Returns: int

DM_UniqueParts

The method returns an indexed unique part associated with this document. Note, if multiple instances of the same part exist, then only one of these parts will be recognized.

IPart DM_UniqueParts(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IPart

Extension method of IDocumentHelper (using EDP;).

DM_UpdateDateModified

The method sets the modified date for this document.

void DM_UpdateDateModified();

Returns: nothing (void)

DM_VHDLEntities

The method returns the indexed VHDL entity instance from this document. Use this in conjunction with the DM_VHDLEntityCount method.

IVHDLEntity DM_VHDLEntities(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IVHDLEntity

Extension method of IDocumentHelper (using EDP;).

See also: IDocument.DM_VHDLEntityCount

DM_VHDLEntityCount

The method denotes the number of VHDL entities from this document. Use this VHDL Entity count in conjunction with the DM_VHDLEntities(Index) to go through each VHDL entity.

int DM_VHDLEntityCount();

Returns: int

See also: IDocument.DM_VHDLEntities

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_OwnerDocument, IDocumentStructure.DM_GetDocument, IDocumentStructure.DM_GetSourceDocument, IPart.DM_ChildProjectSheet, IPart.DM_LogicalOwnerDocument, IProject.DM_DocumentFlattened, IProject.DM_GeneratedDocuments, IProject.DM_GetDocumentByDocumentId, IProject.DM_GetDocumentFromPath, IProject.DM_GetScrapDocument, IProject.DM_LogicalDocuments, IProject.DM_PhysicalDocuments, IProject.DM_PrimaryImplementationDocument, IProject.DM_TopLevelLogicalDocument, IProject.DM_TopLevelPhysicalDocument, IProjectProperties.DM_DeviceSheets, IProjectProperties.DM_ProjectDocuments, ISheetSymbol.DM_ChildSheet, IWorkspace.DM_FocusedDocument, IWorkspace.DM_GetDocumentFromPath, IWorkspace.DM_InstalledLibraries

Accepted by

IBomManagerFactory.GetManagerForCompareDocuments, IBomManagerFactory.GetManagerForDocument, IBomManagerFactory.GetManagerForDocumentPcb, IBomManagerFactory.GetManagerForProjectPcb, ICMP_DocumentComparer.Compare, ICMP_PCBChangesApplier.ApplyChanges, ICMP_PCBChangesApplier.ApplyChangesWithCallback, ICMP_PCBObjectModelImporter.ImportFromPCBDocument, IChangeManager.DM_CreateECO_SwapPin

Examples

Used in the SDK examples: Ciiva, Ciiva, Extension_AddVariant, Extension_BOMManager, Extension_BOMManager, Extension_BOMManager, Extension_BOMManager, Extension_CreateVariantComponent, Extension_HierarchicalDesign, Extension_PartComment, Extension_TestPortHarnessDev.