ISheetSymbol interface

The ISheetSymbol interface is a sheet symbol interface to an existing sheet symbol object on the schematic. Sheet symbols represent other schematic sheets (often referred to as a child sheet). The link between a sheet symbol and other schematic sheets is the FileName attribute, which must be the same as the name of the child sheet.

public interface ISheetSymbol : IDMObject

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IDMObject

Remarks

An equivalent Sheet Symbol object representation is the ISch_SheetSymbol class in Sch API Reference.

Methods

Method	Returns	Description
DM_CalculatedDesignator	string	This method returns the calculated designator string which contains the hierarchical path and the logical designator strings.
DM_ChildSheet	IDocument	Returns the indexed child sheet associated with this sheet symbol object.
DM_ChildSheetCount	int	Returns the number of child sheets associated with this sheet symbol object.
DM_DesignItemID	string
DM_ItemGUID	string
DM_LogicalDesignator	string	Returns the logical designator of this sheet symbol.
DM_PhysicalDesignator	string	Returns the designator of this sheet symbol.
DM_RevisionGUID	string
DM_SheetEntries	INetItem	Returns the number of sheet entries that are associated with this sheet symbol.
DM_SheetEntryCount	int	Returns the number of sheet entries associated with this sheet symbol object.
DM_SheetSymbolFileName	string	Returns the filename which is a link between this sheet symbol object and the other schematic sheet.
DM_SourceLibraryName	string
DM_UniqueId	string	Returns the unique ID of this sheet symbol object.
DM_VaultGUID	string

DM_CalculatedDesignator

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 sheet symbols are calculated based on the physical documents they are on.

string DM_CalculatedDesignator();

Returns: string

DM_ChildSheet

Returns the indexed child sheet associated with this sheet symbol object. Use in conjunction with the DM_ChildSheetCount method.

IDocument DM_ChildSheet(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IDocument

Extension method of ISheetSymbolHelper (using EDP;).

DM_ChildSheetCount

Returns the number of child sheets associated with this sheet symbol object.

int DM_ChildSheetCount();

Returns: int

DM_DesignItemID

No description yet.

string DM_DesignItemID();

Returns: string

DM_ItemGUID

No description yet.

string DM_ItemGUID();

Returns: string

DM_LogicalDesignator

Returns the logical designator of this sheet symbol. A logical designator is not unique, since logical designators are used in multi channel designs.

string DM_LogicalDesignator();

Returns: string

DM_PhysicalDesignator

Returns the designator of this sheet symbol. Every physical designator is unique.

string DM_PhysicalDesignator();

Returns: string

DM_RevisionGUID

No description yet.

string DM_RevisionGUID();

Returns: string

DM_SheetEntries

Returns the number of sheet entries that are associated with this sheet symbol. Since a sheet entry is of a INetItem type, thus a INetItem interface is returned.

INetItem DM_SheetEntries(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: INetItem

Extension method of ISheetSymbolHelper (using EDP;).

DM_SheetEntryCount

Returns the number of sheet entries associated with this sheet symbol object.

int DM_SheetEntryCount();

Returns: int

DM_SheetSymbolFileName

Returns the filename which is a link between this sheet symbol object and the other schematic sheet.

string DM_SheetSymbolFileName();

Returns: string

DM_SourceLibraryName

No description yet.

string DM_SourceLibraryName();

Returns: string

DM_UniqueId

Returns the unique ID of this sheet symbol object.

string DM_UniqueId();

Returns: string

DM_VaultGUID

No description yet.

string DM_VaultGUID();

Returns: string

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

IBlanket.DM_SheetSymbols, IDocument.DM_HarnessConnectors, IDocument.DM_ParentSheetSymbols, IDocument.DM_SheetSymbols, IInstance.DM_SheetSymbol, INetItem.DM_SheetSymbol