TextFrameItem
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| anchor | Point | r/w | The position of the anchor point (start of base line for point text) |
| antialias | TextAntialias: TextAntialias.NONE TextAntialias.SHARP TextAntialias.CRISP TextAntialias.STRONG |
r/w | The type of a text anti-aliasing on text frame item. |
| characters | Characters | readonly | All the characters in this text range. |
| columnCount | Int32 | r/w | The column count in the text frame (area text only) |
| columnGutter | number | r/w | The column gutter in the text frame (area text only) |
| contentVariable | any | r/w | The content variable bound to this text art item. |
| contents | string | r/w | The text contents of this text frame. |
| endTValue | number | r/w | The end position of text along a path, as a value relative to the path's segments (path text only) |
| firstBaseline | FirstBaselineType: FirstBaselineType.BASELINEASCENT FirstBaselineType.BASELINECAPHEIGHT FirstBaselineType.BASELINELEADING FirstBaselineType.BASELINEXHEIGHT FirstBaselineType.BASELINEEMBOXHEIGHT FirstBaselineType.BASELINEFIXED FirstBaselineType.BASELINELEGACY |
r/w | The first baseline offset type for text frame item (for Area Text only) |
| firstBaselineMin | number | r/w | The first baseline offset minimum value for text frame item (for Area Text only) |
| flowLinksHorizontally | bool | r/w | Flow text between linked frame horizontally first. (area text only) |
| insertionPoints | InsertionPoints InsertionPoint | readonly | All the insertion points in this text range. |
| kind | TextType: TextType.POINTTEXT TextType.AREATEXT TextType.PATHTEXT |
readonly | The type of a text frame item. |
| lines | Lines | readonly | All the lines in this text range. |
| matrix | Matrix | readonly | The transformation matrix of the text frame object. |
| nextFrame | TextFrameItem | r/w | The linked text frame following this one. |
| opticalAlignment | bool | r/w | Is the optical alignment active? |
| orientation | TextOrientation: TextOrientation.HORIZONTAL TextOrientation.VERTICAL |
r/w | The orientation of the text in the frame. |
| paragraphs | Paragraphs | readonly | All the paragraphs in this text range. |
| parent | Object | readonly | The object's container. |
| previousFrame | TextFrameItem | r/w | The linked text frame preceding this one. |
| rowCount | Int32 | r/w | The row count in the text frame (area text only) |
| rowGutter | number | r/w | The row gutter in the text frame (area text only) |
| spacing | number | r/w | The amount of spacing (path text only) |
| startTValue | number | r/w | The start position of text along a path, as a value relative to the path's segments (path text only) |
| story | Story | readonly | The story of the text frame. |
| textPath | TextPath | readonly | The path for the text frame (area and path text) |
| textRange | TextRange | readonly | The text range of the text frame. |
| textRanges | TextRanges TextRange | readonly | All the text in this text range. |
| textSelection | Array of TextRange | readonly | The selected text (ranges) in the story. |
| typename | string | readonly | The class name of the object. |
| words | Words | readonly | All the words in this text range. |
Methods
Instances
GroupItem createOutline ()
Convert text item to path items.
TextFrameItem duplicate (relativeObject:
Object, insertionLocation:
ElementPlacement)
Duplicate this object.
| Parameter | Type | Description |
|---|---|---|
| relativeObject | Object | |
| insertionLocation | ElementPlacement |
TextFrameItem move (relativeObject:
Object, insertionLocation:
ElementPlacement)
Move the object.
| Parameter | Type | Description |
|---|---|---|
| relativeObject | Object | |
| insertionLocation | ElementPlacement |
Element of
TextFrameItem.nextFrame
TextFrameItem.previousFrame
Used in:
TextFrameItem TextFrameItems.areaText (textPath: PathItem[, orientation: TextOrientation=TextOrientation.HORIZONTAL][, baseFrame: TextFrameItem][, postFix: bool=true])
TextFrameItem TextFrameItems.pathText (textPath: PathItem[, startTValue: number=0.0][, endTValue: number=0.0][, orientation: TextOrientation=TextOrientation.HORIZONTAL][, baseFrame: TextFrameItem][, postFix: bool=true])
Return
TextFrameItem TextFrameItem.duplicate (relativeObject: Object, insertionLocation: ElementPlacement)
TextFrameItem TextFrameItem.move (relativeObject: Object, insertionLocation: ElementPlacement)
TextFrameItem TextFrameItems.add ()
TextFrameItem TextFrameItems.areaText (textPath: PathItem[, orientation: TextOrientation=TextOrientation.HORIZONTAL][, baseFrame: TextFrameItem][, postFix: bool=true])
TextFrameItem TextFrameItems.getByName (name: string)
TextFrameItem TextFrameItems.pathText (textPath: PathItem[, startTValue: number=0.0][, endTValue: number=0.0][, orientation: TextOrientation=TextOrientation.HORIZONTAL][, baseFrame: TextFrameItem][, postFix: bool=true])
TextFrameItem TextFrameItems.pointText (anchor: Point[, orientation: TextOrientation=TextOrientation.HORIZONTAL])
| Jongware, 25-Nov-2012 v3.0.3i | Contents :: Index |