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

```csharp
public interface ISch_SheetEntry : ISch_GraphicalObject
```

**Namespace:** SCH · **Assembly:** Altium.SDK.Interfaces

**Inherits:** [ISch_BasicContainer](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md) → [ISch_GraphicalObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md)

**Derived:** [ISch_HighLevelCodeEntry](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_HighLevelCodeEntry.md)

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [DistanceFromTop](#distancefromtop) | `int` | get; set | The `DistanceFromTop` property defines the location of the sheet entry in respect to the associated sheet symbol. |
| [HarnessColor](#harnesscolor) | `int` | get; set |  |
| [IOType](#iotype) | [TPortIO](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TPortIO.md) | get; set | The `IOType` property determines the IO of the sheet entry. |
| [Name](#name) | `string` | get; set | The Name property defines the name of the sheet entry. |
| [OverrideDisplayString](#overridedisplaystring) | `string` | get; set | The `OverrideDisplayString` property defines the OverRideDisplayString property. |
| [OwnerSchSheetSymbol](#ownerschsheetsymbol) | [ISch_SheetSymbol](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetSymbol.md) | get |  |
| [Side](#side) | [TLeftRightSide](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TLeftRightSide.md) | get; set | The Side property defines the orientation of the sheet entry in respect to the associated sheet symbol. |
| [Style](#style) | [TPortArrowStyle](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TPortArrowStyle.md) | get; set | The Style property determines the style of the sheet entry and is determined by the [`TPortArrowStyle`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TPortArrowStyle.md) type. |
| [TextColor](#textcolor) | `int` | get; set | The `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.

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

**Type:** `int` · **Access:** read/write

### HarnessColor

*No description yet.*

```csharp
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.

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

**Type:** [TPortIO](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TPortIO.md) · **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](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TPortIO.md)

### Name

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

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

**Type:** `string` · **Access:** read/write

### OverrideDisplayString

The `OverrideDisplayString` property defines the OverRideDisplayString property.

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

**Type:** `string` · **Access:** read/write

**See also:** [ISch_HarnessEntry](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_HarnessEntry.md)

### OwnerSchSheetSymbol

*No description yet.*

```csharp
ISch_SheetSymbol GetState_OwnerSchSheetSymbol();
```

**Type:** [ISch_SheetSymbol](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_SheetSymbol.md) · **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.

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

**Type:** [TLeftRightSide](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TLeftRightSide.md) · **Access:** read/write

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

**See also:** [TLeftRightSide](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TLeftRightSide.md)

### Style

The Style property determines the style of the sheet entry and is determined by the [`TPortArrowStyle`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TPortArrowStyle.md) 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.

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

**Type:** [TPortArrowStyle](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TPortArrowStyle.md) · **Access:** read/write

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

**See also:** [TPortArrowStyle](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TPortArrowStyle.md)

### TextColor

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

```csharp
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

| Method | Returns | Description |
| --- | --- | --- |
| [IsVertical](#isvertical) | `bool` | This 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.

```csharp
bool IsVertical();
```

**Returns:** `bool`

## Inherited members

- From [ISch_GraphicalObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md): [AddErrorString](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#adderrorstring), [AreaColor](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#areacolor), [BoundingRectangle](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#boundingrectangle), [BoundingRectangle_Full](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#boundingrectangle_full), [Color](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#color), [CompilationMasked](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#compilationmasked), [Dimmed](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#dimmed), [Disabled](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#disabled), [DisplayError](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#displayerror), [EnableDraw](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#enabledraw), [ErrorColor](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#errorcolor), [ErrorKind](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#errorkind), [ErrorString](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#errorstring), [GetHash](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#gethash), [GraphicallyInvalidate](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#graphicallyinvalidate), [LiveHighlightValue](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#livehighlightvalue), [Location](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#location), [Mirror](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#mirror), [MoveByXY](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#movebyxy), [MoveToXY](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#movetoxy), [OwnerPartDisplayMode](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#ownerpartdisplaymode), [OwnerPartId](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#ownerpartid), [ResetErrorFields](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#reseterrorfields), [RotateBy90](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#rotateby90), [Selection](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#selection), [SetState_xSizeySize](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_GraphicalObject.md#setstate_xsizeysize)
- From [ISch_BasicContainer](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md): [AddAndPositionSchObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#addandpositionschobject), [AddSchObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#addschobject), [CopyTo](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#copyto), [DeleteAll](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#deleteall), [DescriptionString](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#descriptionstring), [ExportToParameters](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#exporttoparameters), [FreeAllContainedObjects](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#freeallcontainedobjects), [Handle](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#handle), [IdentifierString](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#identifierstring), [Import_FromUser](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#import_fromuser), [ObjectId](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#objectid), [OwnerSchDocument](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#ownerschdocument), [RemoveSchObject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#removeschobject), [Replicate](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#replicate), [SchBasicContainer](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#schbasiccontainer), [SchIterator_Create](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#schiterator_create), [SchIterator_Destroy](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#schiterator_destroy), [SchParameterByName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#schparameterbyname), [Setstate_Default](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#setstate_default), [Text](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#text), [UniqueId](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#uniqueid), [WiringDiagramOriginUniqueId](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_BasicContainer.md#wiringdiagramoriginuniqueid)
