Skip to main content
View as Markdown

ISch_SheetEntry interface

A sheet entry within a Sheet Symbol object creates a connection between the net touching on the parent sheet, to a Port with the same name on the child sheet.

public interface ISch_SheetEntry : ISch_GraphicalObject

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: ISch_BasicContainer → ISch_GraphicalObject

Derived: ISch_HighLevelCodeEntry

Properties​

PropertyTypeAccessDescription
DistanceFromTopintget; setThe DistanceFromTop property defines the location of the sheet entry in respect to the associated sheet symbol.
HarnessColorintget; set
IOTypeTPortIOget; setThe IOType property determines the IO of the sheet entry.
Namestringget; setThe Name property defines the name of the sheet entry.
OverrideDisplayStringstringget; setThe OverrideDisplayString property defines the OverRideDisplayString property.
OwnerSchSheetSymbolISch_SheetSymbolget
SideTLeftRightSideget; setThe Side property defines the orientation of the sheet entry in respect to the associated sheet symbol.
StyleTPortArrowStyleget; setThe Style property determines the style of the sheet entry and is determined by the TPortArrowStyle type.
TextColorintget; setThe TextColor property defines the color (a value of TColor type) for the Harness Entry's Name string.

DistanceFromTop​

The DistanceFromTop property defines the location of the sheet entry in respect to the associated sheet symbol.

int GetState_DistanceFromTop();
void SetState_DistanceFromTop(int argValue);

Type: int · Access: read/write

HarnessColor​

No description yet.

int GetState_HarnessColor();
void SetState_HarnessColor(int argValue);

Type: int · Access: read/write

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

IOType​

The IOType property determines the IO of the sheet entry. This IO Type defines the electrical properties of the sheet entry. Available IOs are: Input, Output, Bi-directional and Unspecified. The IO setting does not influence the connectivity of the circuit, but is considered during the running of an electrical rules check, which can be set to detect incompatible port directions.

TPortIO GetState_IOType();
void SetState_IOType(TPortIO argValue);

Type: TPortIO · Access: read/write

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

Note, the I/O Type of the Sheet Entry overrides the Style property. If the I/O Type is set to Unspecified you can set the appropriate Style for this sheet entry. However if the I/O Type is set to one of the specified I/O types then changing the Style will not update the graphical content of the sheet entry.

See also: TPortIO

Name​

The Name property defines the name of the sheet entry. Normally the name property is a number but can be alphanumeric.

string GetState_Name();
void SetState_Name(string argValue);

Type: string · Access: read/write

OverrideDisplayString​

The OverrideDisplayString property defines the OverRideDisplayString property.

string GetState_OverrideDisplayString();
void SetState_OverrideDisplayString(string argValue);

Type: string · Access: read/write

See also: ISch_HarnessEntry

OwnerSchSheetSymbol​

No description yet.

ISch_SheetSymbol GetState_OwnerSchSheetSymbol();

Type: ISch_SheetSymbol · Access: read-only

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

Side​

The Side property defines the orientation of the sheet entry in respect to the associated sheet symbol.

TLeftRightSide GetState_Side();
void SetState_Side(TLeftRightSide argValue);

Type: TLeftRightSide · Access: read/write

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

See also: TLeftRightSide

Style​

The Style property determines the style of the sheet entry and is determined by the TPortArrowStyle type. This style defines the graphical style of the sheet entry only if the I/O Type property is set to Unspecified. The IO Type of the Sheet Entry overrides the Style property if the I/O Type is set to one of the specified IO types then changing the Style will not update the graphical content of the sheet entry.

TPortArrowStyle GetState_Style();
void SetState_Style(TPortArrowStyle argValue);

Type: TPortArrowStyle · Access: read/write

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

See also: TPortArrowStyle

TextColor​

The TextColor property defines the color (a value of TColor type) for the Harness Entry's Name string.

int GetState_TextColor();
void SetState_TextColor(int argValue);

Type: int · Access: read/write

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

The TColor value specifies a 6 digit hexadecimal number of the $FFFFFF format. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)).

Methods​

MethodReturnsDescription
IsVerticalboolThis method returns a Boolean value that determines whether the sheet entry is aligned vertically or not.

IsVertical​

This method returns a Boolean value that determines whether the sheet entry is aligned vertically or not.

bool IsVertical();

Returns: bool

Inherited members​