Adobe 65030365 - FrameMaker - PC Manual page 559

ADOBE FRAMEMAKER SCRIPTING GUIDE
Function Summary
WrapElement
Description
Inserts a structural element around the selected text and structural elements in a document.
If the flow that contains the selection is unstructured and the selection does not include the entire flow contents,
wraps the flow contents into a
WrapElement()
element definition.
The method does not return anything on success.
On failure, the method returns one of the following values to
Error
Constants.FE_WrongProduct (-60)
Constants.FE_BadDocId (-2)
Constants.FE_BadElementDefId(-28)
Constants.FE_BadSelectionForOperation (-59)
Returns
Void
Syntax
WrapElement()
GetAttributeDefs
Description
Gets the attribute definitions of an element definition.
On success, the method returns an
The field of the returned
attrType
the following constants:
Constant
Constant.FV_AT_STRING (0)
Constant.FV_AT_STRINGS (1)
Constants.FV_AT_CHOICES (2)
Constants.FV_AT_INTEGER (3)
Constants.FV_AT_INTEGERS (4)
Constants.FV_AT_REAL (5)
Constants.FV_AT_REALS (6)
Constants.FV_AT_UNIQUE_ID (7)
Constants.FV_AT_UNIQUE_IDREF (8)
element before wrapping the selection into the specified
NoName
FA_errno
Reason
Current product interface is not Structured FrameMaker.
Invalid document.
Specified element definition is invalid.
Current text selection is invalid for this operation.
structure containing the attribute definitions.
AttributeDefs
structure identifies the attribute value's type. It can specify one of
AttributeDefs
Value
Any arbitrary text string.
One or more arbitrary text strings.
A value from a list of choices.
A signed whole number (optionally restricted to a range of values).
One or more integers (optionally restricted to a range of values).
A real number (optionally restricted to a range of values).
One or more real numbers (optionally restricted to a range of values).
A string that uniquely identifies the element.
A reference to a UniqueID attribute.
Last updated 9/26/2011
:
551