Information Classification: External Restricted.
See https://www.chili-publish.com/security
Document Object Model - TextFrame
A frame containing text. Text can be editable within the editor by the end user, or can be 'variable' (in which case content can only be edited by the administrators directly, or by using variables in the case of an end user).
If the frame is part of a chain, many settings (mostly those applying to the text rather than the container) are inherited from the first frame in the chain.
Fields
Name |
Type |
Triggers |
Description |
---|---|---|---|
textLinks |
|
Text Links (extracted by Editor) |
|
chainNextFrame |
|
Next frame in text story |
|
chainPreviousFrame |
|
Previous frame in text story |
|
chainFirstFrame |
|
First frame in text story |
|
chainLastFrame |
|
Last frame in text story |
|
textFlow |
Text Frame's text (or variable tagging source, if isVariable = true) |
||
displayTextFlow |
TextFlow |
Display text flow (for frames where "isVariable = true") |
|
verticalAlign |
Vertical frame alignment |
||
columns |
int |
Number of text columns |
|
columnGap |
unit |
Gap between text columns |
|
ignoreWrap |
bool |
|
Igore text wrap settings |
isVariable |
bool |
Frame contains variable data |
|
hasTextStroke |
bool |
Text stroke applied? |
|
textStrokeWeight |
number |
Text stroke weight |
|
textStrokeColor |
Text stroke color |
||
applyCopyFitting |
bool |
Apply copyfitting |
|
applyCopyFittingOnOverflowOnly |
bool |
Apply copyfitting only if text is in overflow |
|
copyFittingMaxPercentage |
number |
Max percentage to apply during copyfitting |
|
copyFittingMinPercentage |
number |
Min percentage during copyfitting |
|
copyFittingAppliedPercentage |
number |
Applied percentage after copyfitting |
|
removeEmptyParagraphs |
bool |
Remove empty paragraphs in displayTextFlow, after populating variables |
|
autoGrowFrame |
bool |
If true, auto-grow settings apply |
|
autoGrowDirection |
|
Autogrow direction |
|
autoGrowIncrement |
unit |
|
Autogrow increment (don't set to low, that negatively impacts performance!) |
autoGrowMaximum |
unit |
|
Autogrow maximum value |
autoGrowMinimum |
unit |
|
Autogrow minimum value |
textLineGraphicsBack |
string |
|
Background text graphics |
textLineGraphicsTop |
string |
|
Top text graphics |
textLines |
string |
|
Created text lines (filled by editor for PDF Generation) |
copyFittingMaxLines |
int |
Max. lines for copyfitted result |
|
baseLineGridOptions |
|
Custom baseline grid options |
|
baseLineGridUseCustom |
bool |
If true, the frame's baseLineGridOptions are used rather than the document's |
|
clippingPath |
|
Applied clipping path |
|
hasClippingPath |
bool |
|
Clipping path applied? |
textLanguage |
string |
|
Text language (id or XX system name), to override layer or document settings |
inlineFrames |
|
Inline Frames Collection |
|
textOnPath |
Draw text on path |
||
copyFittingInlineElementWidth |
Include element width in copyfitting |
||
copyFittingInlineElementHeight |
Include element height in copyfitting |
||
textOnPathFlip |
Flip path |
||
textOnPathVerticalAlign |
Vertical align for text paths |
||
textOnPathVerticalOffset |
Vertical offset of text paths |
||
textOnPathCharSpacing |
Character spacing |
||
textOnPathNewPointSpacingBefore |
Point spacing |
||
textOnPathNewPointSpacingAfter |
Point spacing |
||
textOnPathStrokeAlign |
Alignment for text stroke |
||
autoGrowRestrictToPage |
Restrict autogrow to page bounds |
||
hasOverflow |
|
Read-only indication of the overflow status of the text frame |
|
copyFittingStyle |
|
Functions
Called from JavaScript using editor.ExecuteFunction("object_descriptor", "FUNCTION_NAME", args...)
Name |
Arguments |
Returns |
Description |
---|---|---|---|
GetText |
[formatted (bool) |
|
Returns the text in the text frame, as a string |
ImportTextFlow |
|
Imports a textFlow object (as a valid XML string) into the text frame's content |
Inherits from
> DocumentBase#/Cooklist/DocumentBase
> DocumentListItemBase#/Cooklist/DocumentListItemBase
> Frame