ISch_Sheet interface

Created: May 20, 2013 | Updated: November 15, 2016

Overview 
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.

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.

Notes 
The ISch_Sheet interface hierarchy is as follows;
ISch_BasicContainer
ISch_GraphicalObject
ISch_ParameterizedGroup
ISch_Document
ISch_Sheet

ISch_Sheet 
methods 
GetState_WireConnections
GetState_BusConnections
OptimizeUseOfPolylines GetState_HarnessDefinitionsChanged
Reset_HarnessDefinitionsChanged
Raise_HarnessDefinitionsChanged

ISch_Sheet 
properties 
WireConnections
BusConnections
HarnessDefinitionsChanged

See also 
ISch_Document interface
ISch_Lib interface

ISch_Sheet Methods

GetState_BusConnections method

(ISch_Sheet interface)
Syntax 
Function GetState_BusConnections : IConnectionsArray;
Description 
This function fetches the connections of the busses on a schematic document. This method is used in the BusConnections property.
Example

See also 
ISch_Sheet interface

GetState_WireConnections method

(ISch_Sheet interface)
Syntax 
Function GetState_WireConnections : IConnectionsArray;
Description 
This function fetches the connections of the wires on a schematic document. This method is used in the WireConnections property.
Example

See also 
ISch_Sheet interface

OptimizeUseOfPolylines method

(ISch_Sheet interface)
Syntax 
Procedure OptimizeUseOfPolylines;
Description 
This procedure forces the optimal connection of polylines graphically and in the datastructure.
Example

See also 
ISch_Sheet interface

GetState_HarnessDefinitionsChanged

(ISch_Sheet interface)
Syntax 
Function GetState_HarnessDefinitionsChanged : Boolean;
Description

Example

See also 
ISch_Sheet interface

Reset_HarnessDefinitionsChanged

(ISch_Sheet interface)
Syntax 
Procedure Reset_HarnessDefinitionsChanged; 
Description

Example

See also 
ISch_Sheet interface

Raise_HarnessDefinitionsChanged

(ISch_Sheet interface)
Syntax 
Procedure Raise_HarnessDefinitionsChanged;
Description

Example

See also 
ISch_Sheet interface

ISch_Sheet Properties

BusConnections property

(ISch_Sheet interface)
Syntax 
Property BusConnections : IConnectionsArray Read GetState_BusConnections;
Description 
This property fetches the connections of busses on the schematic document. This property is supported by the GetState_BusConnections method.
Example

See also 
ISch_Sheet interface

WireConnections property

(ISch_Sheet interface)
Syntax 
Property WireConnections : IConnectionsArray Read GetState_WireConnections;
Description 
This property fetches the connections of wires on the schematic document. This property is supported by the GetState_WireConnections method.
Example

See also 
ISch_Sheet interface

HarnessDefinitionsChanged property

(ISch_Sheet interface)
Syntax 
Property HarnessDefinitionsChanged : Boolean Read GetState_HarnessDefinitionsChanged;
Description 
This property is supported by the GetState_HarnessDefinitionsChanged method.
Example

See also 
ISch_Sheet interface

Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: