ISch_TextFrame interface
Text frames hold multiple lines of free text.
public interface ISch_TextFrame : ISch_Rectangle
Namespace: SCH · Assembly: Altium.SDK.Interfaces
Inherits: ISch_BasicContainer → ISch_GraphicalObject → ISch_Rectangle
Derived: ISch_Note
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 | THorizontalAlign | get; set | |
| ClipToRect | bool | get; set | |
| FontId | int | get; set | |
| ShowBorder | bool | get; set | |
| TextColor | int | get; set | |
| TextMargin | int | get; set | |
| TextMargins | CoordRect | get; set | |
| WordWrap | bool | get; set |
Alignment
No description yet.
THorizontalAlign GetState_Alignment();
void SetState_Alignment(THorizontalAlign argValue);
Type: THorizontalAlign · Access: read/write
The accessors are extension methods of ISch_TextFrameHelper (using SCH;).
ClipToRect
No description yet.
bool GetState_ClipToRect();
void SetState_ClipToRect(bool argValue);
Type: bool · Access: read/write
FontId
No description yet.
int GetState_FontId();
void SetState_FontId(int argValue);
Type: int · Access: read/write
ShowBorder
No description yet.
bool GetState_ShowBorder();
void SetState_ShowBorder(bool argValue);
Type: bool · Access: read/write
TextColor
No description yet.
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.
int GetState_TextMargin();
void SetState_TextMargin(int argValue);
Type: int · Access: read/write
TextMargins
No description yet.
CoordRect GetState_TextMargins();
void SetState_TextMargins(CoordRect argValue);
Type: CoordRect · Access: read/write
The accessors are extension methods of ISch_TextFrameHelper (using SCH;).
WordWrap
No description yet.
bool GetState_WordWrap();
void SetState_WordWrap(bool argValue);
Type: bool · Access: read/write
Inherited members
- From ISch_Rectangle: Corner, IsSolid, LineWidth, Transparent
- From ISch_GraphicalObject: AddErrorString, AreaColor, BoundingRectangle, BoundingRectangle_Full, Color, CompilationMasked, Dimmed, Disabled, DisplayError, EnableDraw, ErrorColor, ErrorKind, ErrorString, GetHash, GraphicallyInvalidate, LiveHighlightValue, Location, Mirror, MoveByXY, MoveToXY, OwnerPartDisplayMode, OwnerPartId, ResetErrorFields, RotateBy90, Selection, SetState_xSizeySize
- From ISch_BasicContainer: AddAndPositionSchObject, AddSchObject, CopyTo, DeleteAll, DescriptionString, ExportToParameters, FreeAllContainedObjects, Handle, IdentifierString, Import_FromUser, ObjectId, OwnerSchDocument, RemoveSchObject, Replicate, SchBasicContainer, SchIterator_Create, SchIterator_Destroy, SchParameterByName, Setstate_Default, Text, UniqueId, WiringDiagramOriginUniqueId