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

TextFrameLinks

 

Text Links (extracted by Editor)

chainNextFrame

TextFrame

 

Next frame in text story

chainPreviousFrame

TextFrame

 

Previous frame in text story

chainFirstFrame

TextFrame

 

First frame in text story

chainLastFrame

TextFrame

 

Last frame in text story

textFlow

TextFlow

SelectionContentChanged

Text Frame's text (or variable tagging source, if isVariable = true)

displayTextFlow

TextFlow

SelectionContentChanged

Display text flow (for frames where "isVariable = true")

verticalAlign

TextFrameAlignment

SelectionContentChanged

Vertical frame alignment

columns

int

SelectionContentChanged

Number of text columns

columnGap

unit

SelectionContentChanged

Gap between text columns

ignoreWrap

bool

 

Igore text wrap settings

isVariable

bool

SourceViewChanged

Frame contains variable data

hasTextStroke

bool

TextFrameStrokeChanged

Text stroke applied?

textStrokeWeight

number

TextFrameStrokeChanged

Text stroke weight

textStrokeColor

Color

TextFrameStrokeChanged

Text stroke color

applyCopyFitting

bool

SourceViewChanged

Apply copyfitting

applyCopyFittingOnOverflowOnly

bool

SourceViewChanged

Apply copyfitting only if text is in overflow

copyFittingMaxPercentage

number

SourceViewChanged

Max percentage to apply during copyfitting

copyFittingMinPercentage

number

SourceViewChanged

Min percentage during copyfitting

copyFittingAppliedPercentage

number

TextFrameCopyFittingAppliedPercentageChanged

Applied percentage after copyfitting

removeEmptyParagraphs

bool

SourceViewChanged

Remove empty paragraphs in displayTextFlow, after populating variables

autoGrowFrame

bool

SelectionContentChanged

If true, auto-grow settings apply

autoGrowDirection

TextFrameAutoGrowDirection

 

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

SourceViewChanged

Max. lines for copyfitted result

baseLineGridOptions

BaseLineGridOptions

 

Custom baseline grid options

baseLineGridUseCustom

bool

TextFrameCustomBaseLineGridChanged

If true, the frame's baseLineGridOptions are used rather than the document's

clippingPath

Paths

 

Applied clipping path

hasClippingPath

bool

 

Clipping path applied?

textLanguage

string

 

Text language (id or XX system name), to override layer or document settings

inlineFrames

InlineFrames

 

Inline Frames Collection

textOnPath

bool

TextFramePathSettingChanged

Draw text on path

copyFittingInlineElementWidth

bool

SourceViewChanged

Include element width in copyfitting

copyFittingInlineElementHeight

bool

SourceViewChanged

Include element height in copyfitting

textOnPathFlip

bool

TextFramePathSettingChanged

Flip path

textOnPathVerticalAlign

TextPathVerticalAlignment

TextFramePathSettingChanged

Vertical align for text paths

textOnPathVerticalOffset

unit

TextFramePathSettingChanged

Vertical offset of text paths

textOnPathCharSpacing

unit

TextFramePathSettingChanged

Character spacing

textOnPathNewPointSpacingBefore

unit

TextFramePathSettingChanged

Point spacing

textOnPathNewPointSpacingAfter

unit

TextFramePathSettingChanged

Point spacing

textOnPathStrokeAlign

TextPathStrokeAlignment

TextFramePathSettingChanged

Alignment for text stroke

autoGrowRestrictToPage

bool

SelectionContentChanged

Restrict autogrow to page bounds

hasOverflow

bool

 

Read-only indication of the overflow status of the text frame

copyFittingStyle

CopyFittingStyle#/Cooklist/CopyFittingStyle

SourceViewChanged

 

Functions

Called from JavaScript using editor.ExecuteFunction("object_descriptor", "FUNCTION_NAME", args...)

Name

Arguments

Returns

Description

GetText

[formatted (bool)
forDisplay ()#/Cooklist/formatted (bool)
forDisplay ()]

 

Returns the text in the text frame, as a string

ImportTextFlow

textFlowXml (string)

 

Imports a textFlow object (as a valid XML string) into the text frame's content

Inherits from

> DocumentBase#/Cooklist/DocumentBase
> DocumentListItemBase#/Cooklist/DocumentListItemBase
> Frame