452
ADOBE FRAMEMAKER SCRIPTING GUIDE
Function Summary
Last updated 9/26/2011
Parameters
GetText
Description
The
GetText()
method gets the text from the following types of objects:
•
Cell
•
Element
•
Flow
•
Fn
•
Pgf
•
SubCol
•
TextFrame
•
TextLine
•
TiApiClient
•
TiFlow
•
TiText
•
TiTextTable
•
XRef
Call this method on the document as follows:
document.GetText(flags)
GetText()
returns an object containing an array of text items. Each text item contains either a string of text, an object
that appears within the text (such as a table or an anchored frame), an indicator that the text properties have changed,
or the object that organizes the text (such as a paragraph or a text column).
Note:
Use the
DeallocateTextItems()
method to deallocate the memory used by the
TextItems
structure returned
by
GetText()
when you have finished using it.
To get specific types of text items,
OR
the constants that represent them (for example, use a bitwise OR to combine
FTI_FlowBegin
and
FTI_String
) into flags. To get all types of text items, specify -1.
The method returns a
TextItems
object containing the array of text items of the requested text types.
TextItem.dataType
can be one of the following constants:
Parameter name
Data Type
Optional
Description
heightInRows
int
No
The number of cells to unstraddle vertically.
widthInCols
int
No
The number of cells to unstraddle horizontally.
Text Item Type
Text Item Represents
Text Item Data
FTI_CharPropsChange
A change in the text properties
Flags indicating which properties have changed (see the
following table).
FTI_ElementBegin
The beginning of a container structural
element
FO_Element