Skip to main content
View as Markdown

ISch_Sheet interface

The ISch_Sheet interface represents an existing schematic document open in Altium Designer. A schematic document can have bus and wiring connections which are represented by the IConnectionsArray interface.

public interface ISch_Sheet : ISch_Document

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: ISch_BasicContainer → ISch_GraphicalObject → ISch_ParametrizedGroup → ISch_Document

Remarks​

You can modify or set the document's preference settings.

You can iterate design objects in a Schematic or library document, see ISch_Iterator interface for details.

You can invoke the ChooseLocationInteractively or ChooseRectangleInteractively methods to obtain coordinates from the Schematic sheet or library sheet.

You can create a library from a project that has components

You can check whether objects exist on a particular point on a schematic or library document.

Properties​

PropertyTypeAccessDescription
BusConnectionsIConnectionsArraygetThis property fetches the connections of busses on the schematic document.
HarnessDefinitionsChangedboolget
ItemRevisionGUIDstringget; set
ReleaseItemGUIDstringget; set
ReleaseVaultGUIDstringget; set
WireConnectionsIConnectionsArraygetThis property fetches the connections of wires on the schematic document.

BusConnections​

This property fetches the connections of busses on the schematic document.

IConnectionsArray GetState_BusConnections();

Type: IConnectionsArray · Access: read-only

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

HarnessDefinitionsChanged​

No description yet.

bool GetState_HarnessDefinitionsChanged();

Type: bool · Access: read-only

ItemRevisionGUID​

No description yet.

string GetState_ItemRevisionGUID();
void SetState_ItemRevisionGUID(string argValue);

Type: string · Access: read/write

ReleaseItemGUID​

No description yet.

string GetState_ReleaseItemGUID();
void SetState_ReleaseItemGUID(string argValue);

Type: string · Access: read/write

ReleaseVaultGUID​

No description yet.

string GetState_ReleaseVaultGUID();
void SetState_ReleaseVaultGUID(string argValue);

Type: string · Access: read/write

WireConnections​

This property fetches the connections of wires on the schematic document.

IConnectionsArray GetState_WireConnections();

Type: IConnectionsArray · Access: read-only

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

Methods​

MethodReturnsDescription
OptimizeUseOfPolylinesvoidThis method forces the optimal connection of polylines graphically and in the datastructure.
Raise_HarnessDefinitionsChangedvoid
Reset_HarnessDefinitionsChangedvoid

OptimizeUseOfPolylines​

This method forces the optimal connection of polylines graphically and in the datastructure.

void OptimizeUseOfPolylines();

Returns: nothing (void)

Raise_HarnessDefinitionsChanged​

No description yet.

void Raise_HarnessDefinitionsChanged();

Returns: nothing (void)

Reset_HarnessDefinitionsChanged​

No description yet.

void Reset_HarnessDefinitionsChanged();

Returns: nothing (void)

Inherited members​