Adobe 65030365 - FrameMaker - PC Manual page 476

ADOBE FRAMEMAKER SCRIPTING GUIDE
Function Summary
Flags
Constants.FF_CUT_TBL_CELLS (0x0002)
Constants.FF_VISIBLE_ONLY (0x0010)
Constants.FF_DONT_DELETE_HIDDEN_TEXT (0x0004)
The
Constants.FF_INTERACTIVE
| Constants.FF_DONT_DELETE_HIDDEN_TEXT
to select whether to delete the hidden text or to retain it.
The method returns
FE_Success
:
FA_errno
Error
Constants.FE_BadDocId (-2)
Constants.FE_BadSelectionForOperation (-59)
Constants.FE_Canceled (-44)
Constants.FE_WrongProduct (-60)
Returns
int
Syntax
Clear(flags)
Parameters
Parameter name
flags
ClearAllChangebars
Description
Clears all change bars from a specified document.
Note: The method performs the same function as clicking the Clear All Change Bars box in the Change Bars dialog box.
The method returns
FE_Success
:
FA_errno
Error
Constants.FE_BadDocId (-2)
Constants.FE_WrongProduct (-60)
Constants.FE_SystemError (-42)
Meaning
Remove cleared table cells.
Clear only the visible portion of the selection.
Do not delete hidden text.
flag takes precedence over other flags. If you specify
and the selection contains hidden text, then FrameMaker allows you
if it succeeds. On failure, the method returns one of the following values to
Reason
Invalid document.
Current selection is invalid for this operation.
The User or parameters canceled the operation.
The current FrameMaker version does not support the requested operation.
Data Type Optional
No
int
if it succeeds. On failure, the method returns one of the following values to
Reason
Invalid document.
The current FrameMaker version does not support the requested operation.
A system error occurred.
Last updated 9/26/2011
Constants.FF_INTERACTIVE
Description
Bit field that specifies how to clear the text and how to handle
interactive alerts. For default settings, specify 0.
468