ISch_SheetSymbol interface

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 ISch_SheetSymbol : ISch_RectangularGroup

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: ISch_BasicContainer → ISch_GraphicalObject → ISch_ParametrizedGroup → ISch_RectangularGroup

Derived: ISch_HighLevelCodeSymbol

Properties

Property	Type	Access	Description
DesignItemId	string	get; set
IsSolid	bool	get; set	The IsSolid property denotes whether the sheet symbol object has a solid fill or not.
ItemGUID	string	get; set
LibIdentifierKind	TLibIdentifierKind	get
LibraryIdentifier	string	get
LineWidth	TSize	get; set	The LineWidth property defines the border width of the sheet symbol with one of the following values from the TSize enumerated type.
RevisionGUID	string	get; set
SchSheetFileName	ISch_SheetFileName	get	The SchSheetFileName property denotes the FileName text object which is represented by the ISch_SheetFileName interface object associated with the sheet symbol.
SchSheetName	ISch_SheetName	get	The SchSheetName property denotes the Designator Name text object which is represented by the ISch_SheetName interface object associated with the sheet symbol.
ShowHiddenFields	bool	get; set	The ShowHiddenFields property determines the visibility of the text fields associated with the sheet symbol, such as its name and filename.
SourceLibraryName	string	get; set
SymbolType	TSheetSymbolType	get; set
VaultGUID	string	get; set

DesignItemId

No description yet.

string GetState_DesignItemId();
void SetState_DesignItemId(string argValue);

Type: string · Access: read/write

IsSolid

The IsSolid property denotes whether the sheet symbol object has a solid fill or not.

bool GetState_IsSolid();
void SetState_IsSolid(bool argValue);

Type: bool · Access: read/write

ItemGUID

No description yet.

string GetState_ItemGUID();
void SetState_ItemGUID(string argValue);

Type: string · Access: read/write

LibIdentifierKind

No description yet.

TLibIdentifierKind GetState_LibIdentifierKind();

Type: TLibIdentifierKind · Access: read-only

The accessors are extension methods of ISch_SheetSymbolHelper (using SCH;).

LibraryIdentifier

No description yet.

string GetState_LibraryIdentifier();

Type: string · Access: read-only

LineWidth

The LineWidth property defines the border width of the sheet symbol with one of the following values from the TSize enumerated type.

TSize GetState_LineWidth();
void SetState_LineWidth(TSize argValue);

Type: TSize · Access: read/write

The accessors are extension methods of ISch_SheetSymbolHelper (using SCH;).

See also: TSize

RevisionGUID

No description yet.

string GetState_RevisionGUID();
void SetState_RevisionGUID(string argValue);

Type: string · Access: read/write

SchSheetFileName

The SchSheetFileName property denotes the FileName text object which is represented by the ISch_SheetFileName interface object associated with the sheet symbol. The ISch_SheetFileName interface is inherited from the ISch_ComplexText and ISch_Label interfaces.

ISch_SheetFileName GetState_SchSheetFileName();

Type: ISch_SheetFileName · Access: read-only

The accessors are extension methods of ISch_SheetSymbolHelper (using SCH;).

Example: Show the file name of every sheet symbol on the current schematic sheet.

using SCH;

ISch_Document currentSheet = SCH.GlobalVars.SchServer?.GetCurrentSchDocument();
if (currentSheet == null)
    return;
ISch_Iterator iterator = currentSheet.SchIterator_Create();
iterator.AddFilter_ObjectSet(new SCH.TObjectSet { TObjectId.eSheetSymbol });
try
{
    for (var sSheet = iterator.FirstSchObject() as ISch_SheetSymbol; sSheet != null; sSheet = iterator.NextSchObject() as ISch_SheetSymbol)
    {
        ISch_SheetFileName sheetFileName = sSheet.GetState_SchSheetFileName();
        if (sheetFileName != null)
            DXP.Utils.ShowMessage(sheetFileName.GetState_Text());
    }
}
finally
{
    currentSheet.SchIterator_Destroy(ref iterator);
}

SchSheetName

The SchSheetName property denotes the Designator Name text object which is represented by the ISch_SheetName interface object associated with the sheet symbol. The ISch_SheetName interface is inherited from the ISch_ComplexText and ISch_Label interfaces.

ISch_SheetName GetState_SchSheetName();

Type: ISch_SheetName · Access: read-only

The accessors are extension methods of ISch_SheetSymbolHelper (using SCH;).

Example: Show the sheet name of every sheet symbol on the current schematic sheet.

using SCH;

ISch_Document currentSheet = SCH.GlobalVars.SchServer?.GetCurrentSchDocument();
if (currentSheet == null)
    return;
ISch_Iterator iterator = currentSheet.SchIterator_Create();
iterator.AddFilter_ObjectSet(new SCH.TObjectSet { TObjectId.eSheetSymbol });
try
{
    for (var sSheet = iterator.FirstSchObject() as ISch_SheetSymbol; sSheet != null; sSheet = iterator.NextSchObject() as ISch_SheetSymbol)
    {
        ISch_SheetName sheetName = sSheet.GetState_SchSheetName();
        if (sheetName != null)
            DXP.Utils.ShowMessage(sheetName.GetState_Text());
    }
}
finally
{
    currentSheet.SchIterator_Destroy(ref iterator);
}

ShowHiddenFields

The ShowHiddenFields property determines the visibility of the text fields associated with the sheet symbol, such as its name and filename. If the Value is true, the hidden fields of the sheet symbol will be displayed on the schematic sheet. If the value is false, the hidden text fields are not shown on the schematic.

bool GetState_ShowHiddenFields();
void SetState_ShowHiddenFields(bool argValue);

Type: bool · Access: read/write

SourceLibraryName

No description yet.

string GetState_SourceLibraryName();
void SetState_SourceLibraryName(string argValue);

Type: string · Access: read/write

SymbolType

No description yet.

TSheetSymbolType GetState_SymbolType();
void SetState_SymbolType(TSheetSymbolType argValue);

Type: TSheetSymbolType · Access: read/write

The accessors are extension methods of ISch_SheetSymbolHelper (using SCH;).

VaultGUID

No description yet.

string GetState_VaultGUID();
void SetState_VaultGUID(string argValue);

Type: string · Access: read/write

Methods

Method	Returns	Description
ChangeSymbolType	void

ChangeSymbolType

No description yet.

void ChangeSymbolType(TSheetSymbolType argType);
void ChangeSymbolType(int argType);

Parameter	Type	Passing
argType	TSheetSymbolType	value

Returns: nothing (void)

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

Inherited members

• From ISch_RectangularGroup: XSize, YSize
• From ISch_ParametrizedGroup: Import_FromUser_Parameters, ResetAllSchParametersPosition
• From ISch_GraphicalObject: AddErrorString, AreaColor, BoundingRectangle, BoundingRectangle_Full, Color, CompilationMasked, Dimmed, Disabled, DisplayError, EnableDraw, ErrorColor, ErrorKind, ErrorString, GetHash, GraphicallyInvalidate, LiveHighlightValue, Location, Mirror, MoveByXY, MoveToXY, OwnerPartDisplayMode, OwnerPartId, ResetErrorFields, RotateBy90, Selection, SetState_xSizeySize
• From ISch_BasicContainer: AddAndPositionSchObject, AddSchObject, CopyTo, DeleteAll, DescriptionString, ExportToParameters, FreeAllContainedObjects, Handle, IdentifierString, Import_FromUser, ObjectId, OwnerSchDocument, RemoveSchObject, Replicate, SchBasicContainer, SchIterator_Create, SchIterator_Destroy, SchParameterByName, Setstate_Default, Text, UniqueId, WiringDiagramOriginUniqueId

Returned by

ISch_ServerInterface.LoadDesignItemDeviceSheet, ISch_SheetEntry.OwnerSchSheetSymbol