
# ISch_TextFrame interface

Text frames hold multiple lines of free text.

```csharp
public interface ISch_TextFrame : ISch_Rectangle
```

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

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

## Remarks

The FontID property denotes the font type of the TextFrame object. Windows true Type fonts are fully supported. The FontID value denotes which font has been used. The FontID is the index to an entry in the font table in the Schematic editor. Each font used in the Schematic editor has its own FontID.

When a new font is used (through a Change Font dialog), a new FontID is added to the internal table in the Schematic editor. The FontID value can be extracted from the following Schematic objects (TextField, Sheet, Annotation, TextFrame and NetLabel objects).

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [Alignment](#alignment) | [THorizontalAlign](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/THorizontalAlign.md) | get; set |  |
| [ClipToRect](#cliptorect) | `bool` | get; set |  |
| [FontId](#fontid) | `int` | get; set |  |
| [ShowBorder](#showborder) | `bool` | get; set |  |
| [TextColor](#textcolor) | `int` | get; set |  |
| [TextMargin](#textmargin) | `int` | get; set |  |
| [TextMargins](#textmargins) | [CoordRect](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/CoordRect.md) | get; set |  |
| [WordWrap](#wordwrap) | `bool` | get; set |  |

### Alignment

*No description yet.*

```csharp
THorizontalAlign GetState_Alignment();
void SetState_Alignment(THorizontalAlign argValue);
```

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

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

### ClipToRect

*No description yet.*

```csharp
bool GetState_ClipToRect();
void SetState_ClipToRect(bool argValue);
```

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

### FontId

*No description yet.*

```csharp
int GetState_FontId();
void SetState_FontId(int argValue);
```

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

### ShowBorder

*No description yet.*

```csharp
bool GetState_ShowBorder();
void SetState_ShowBorder(bool argValue);
```

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

### TextColor

*No description yet.*

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

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

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

### TextMargin

*No description yet.*

```csharp
int GetState_TextMargin();
void SetState_TextMargin(int argValue);
```

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

### TextMargins

*No description yet.*

```csharp
CoordRect GetState_TextMargins();
void SetState_TextMargins(CoordRect argValue);
```

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

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

### WordWrap

*No description yet.*

```csharp
bool GetState_WordWrap();
void SetState_WordWrap(bool argValue);
```

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

## Inherited members

- From [ISch_Rectangle](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_Rectangle.md): [Corner](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_Rectangle.md#corner), [IsSolid](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_Rectangle.md#issolid), [LineWidth](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_Rectangle.md#linewidth), [Transparent](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISch_Rectangle.md#transparent)
- 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)
