Adobe 65030365 Scripting Guide - Page 433
NewBookComponentInHierarchy
UPC - 883919170923
View all Adobe 65030365 manuals
Add to My Manuals
Save this manual to your list of manuals |
Page 433 highlights
ADOBE FRAMEMAKER SCRIPTING GUIDE 425 Function Summary The method returns the comparison results in the CompareRet object on success. On failure, the method assigns one of the following values to FA_errno: Error Constants.FE_BadDocId (-2) Constants.FE_BadCompare (-35) Constants.FE_CompareTypes (-34) Constants.FE_WrongProduct (-60) Reason Invalid document. Older and newer documents are not the same types of files. One of the files is not a FrameMaker document or book or one file is a book and the other is a document. Current FrameMaker version does not support the operation. Returns CompareRet Syntax Compare(newerDoc, flags, insertCondTag, deleteCondTag, replaceText, compareThreshold) Parameters Parameter name newerDoc flags insertCondTag deleteCondTag replaceText compareThreshold Data Type Doc int Optional No No string No string No string No int No Description The newer version of the document or book. Bit flags that specify how to generate the summary and composite documents. Specify 0 for the default flags. Indicates the condition tag to apply to insertions shown in the composite document. To specify a blank insert condition tag, enter the value null. Denotes the condition tag to apply to deletions shown in the composite document. To specify a blank delete condition tag, enter the value null. Text to appear in place of the deleted text. To not specify any replacement text, enter the value null. Threshold expresses the percentage of words that can change before paragraphs are considered not equal. If two paragraphs are equal, word differences between them are shown within a paragraph in the composite document. If the compareThreshold property is set to 0, the Compare() method uses the default value of 75. If the compareThreshold property is set to any other value, the Compare() method uses the setting in the FrameMaker configuration files. NewBookComponentInHierarchy Description The NewBookComponentInHierarchy() method inserts a book component at a specified position in a FrameMaker structured book, and returns the component that was newly added, on success. The method returns the element that was added, on success. On failure, the method assigns one of the following values to FA_errno: Last updated 9/26/2011