Adobe 65030365 - FrameMaker - PC Manual page 486

ADOBE FRAMEMAKER SCRIPTING GUIDE
Function Summary
Error
Constants.FE_BadObjId (-3)
Constants.FE_NotTextObject (-41)
Constants.FE_OffsetNotFound (-21)
Constants.FE_WrongProduct (-60)
Returns
PropVals
Syntax
GetTextProps(textLoc)
Parameters
Parameter name
textLoc
GetTextPropVal
Description
Gets a text property (such as the format tag, font family and size, or conditions) for a location in text.
As a text property can be different for each character, you can get the property for only one location in text at a time.
On success, the method returns a
returns one of the following values to
Error
Constants.FE_BadDocId (-2)
Constants.FE_BadObjId (-3)
Constants.FE_BadPropNum (-4)
Constants.FE_BadPropType (-5)
Constants.FE_WrongProduct (-60)
Returns
PropVal
Syntax
GetTextPropVal(textLoc, propNum)
Reason
Invalid Object
Object specified for the text range is not an object that contains text.
Offset specified for the text location could not be found in the specified paragraph or text line.
The current FrameMaker version does not support the requested operation
Data Type Optional
No
TextLoc
structure with the details of the specified property.On failure, the method
PropVal
:
FA_errno
Reason
Invalid document.
Invalid Object
Specified property number is invalid.
Incorrect property type for this function.
The current FrameMaker version does not support the requested operation
Last updated 9/26/2011
Description
The text location of the character that you want to get text
properties for. The returned properties are the properties that
apply to the character to the right of the specified location.
478