Adobe 65030365 - FrameMaker - PC Manual page 484

ADOBE FRAMEMAKER SCRIPTING GUIDE
Function Summary
Flags
Constants.FTF_UNDERLINING
(0x08000000)
Constants.FTF_VARIATION
(0x40000000)
Constants.FTF_WEIGHT
(0x20000000)
On success, the method returns a
On failure, the method sets the
values to :
FA_errno
Error
Constants.FE_BadDocId (-2)
Constants.FE_BadObjId (-3)
Constants.FE_NotTextObject (-41)
Constants.FE_BadRange (-36)
Constants.FE_OffsetNotFound (-21)
Note: The returned TextItems structure references memory that is allocated by the method. Use the
DeallocateTextItems() method to free this memory when you are done with using it.
Returns
TextItems
Syntax
GetTextForRange(tr, flags)
Parameters
Parameter name
tr
flags
GetTextForRange2
Description
Gets the text for a specified text range.
You can OR the same flags as in the
On success, the method returns a
Meaning
The underlining has changed.
The font variation has changed.
The font weight has changed.
structure containing the array of text items of the requested types.
TextItems
field of the returned
len TextItems
Reason
Invalid document.
Invalid Object
Object specified for the text range is not an object that contains text.
Specified text range is invalid.
Offset specified for the text location could not be found in the specified paragraph or text line.
Data Type Optional
TextRange No
No
int
GetTextForRange()
structure containing the array of text items of the requested types.
TextItems
Last updated 9/26/2011
structure to 0, and returns one of the following
Description
The text range containing the text you want to get.
Bit flags that specify the type of text items to retrieve. To get
specific types of text items, OR the constants that represent
them (for example, FTI_FlowBegin and FTI_String) into flags. To
get all types of text items, specify -1.
method, for the flags parameter.
476