BookDontUpdateReferences

number

Set to 0 if FrameMaker is set to update cross-references when it opens the book; Set to 1, otherwise.

BookIsModified

number

Set to 1 if the book has been modified; Set to 0, otherwise.

BookIsSelected

number

Set to 1 if the book icon in the book window is selected; Set to 0 otherwise.

FirstComponentInBook

BookComponent

Denotes the first component in the book.

FirstSelectedComponentInBook

BookComponent

Denotes the first selected component in the book.

IsIconified

number

Set to 1 if the book window is iconified; set to 0 otherwise.

IsInFront

number

Set to 1 if the book window is in front of other windows in the FrameMaker product session; Set to 0 otherwise.

IsOnScreen

number

Set to 1 if the document is visible on the screen; Set to 0 otherwise.

Note: The IsOnScreen property is always 1 for books, and setting it to 0 has no effect.

Label

string

Denotes the title in the book window title bar.

Name

string

Indicates the path of the book.

NextOpenBookInSession

Book

Denotes the next open book in FrameMaker session's list of open books.

StatusLine

string

String that appears in the book status bar. Querying this string returns the status string.

ScreenHeight

number

Denotes the height of the book window in pixels.

ScreenWidth

number

Denotes the width of the book window in pixels.

ScreenX

number

Specifies the offset of the book window in pixels from the left side of the screen (or the left of the FrameMaker product application window).

If you set a value that results in the book window being off the screen, that value is ignored and the old value is retained.

ScreenY

number

Indicates the offset of the book window in pixels from the top of the screen (or the top of the FrameMaker product application window ).

If you set a value that results in the book window being off the screen, that value is ignored and the old value is retained.

TypeOfDisplayText

number

Specifies the type of text snippet to display for each icon in the book window. The two possible values are:

•Constants.FV_BK_FILENAME (1)- displays the book compo­nent's filename

•Constants.FV_BK_TEXT (2) - displays the first paragraph of the component's first flow.

AcrobatBookmarkDisplayTags

number

Set to 1 if the IncludeParagraphTagsinBookmarkText property is set to 1 (the paragraph tag is added before the paragraph text in each bookmark); Set to 0 otherwise.

DocAcrobatColumnArticleThreads

number

Set to 1 if you want separate article threads for each column; set to 0 if you want separate article threads for each text frame.

note:    The DocPDFNoArticleThread property must be set to FALSE, when setting this option.

DocAcrobatDefaultsChanged

number

Set to 1 if the default heuristics for determining the paragraph level are disabled; Set to 0, otherwise.

DocAcrobatElementList

Strings

Contains a list of the element tags and context labels to include in bookmarks.

note:    The DocPDFElementList property applies only to structured FrameMaker documents.

DocAcrobatElements

number

Set to 1 if elements rather than paragraphs are used for bookmarks; Set to 0 otherwise.

note:    The DocPDFElements property applies only to structured FrameMaker documents.

DocAcrobatNoArticleThreads

number

Set to 1 if you do not want article threads in the resulting PDF; Set to 0 otherwise.

GenerateAcrobatInfo

number

Set to 1 if the GenerateAdobeAcrobatData property is set to True. Else, set to 0.

To generate PDF data, you must set the other document print properties as follows:

•PrintToFile - True

•PrintThumbnails - False

•PrintSeps - False

•PrintBlankPages - True

•PrintLastSheetFirst - False

•PrintNumCopies - 1

•PrintOddPages - True

•PrintEvenPages - True

•PrintScale - 100%

PDFBookmark

bool

Set to True if FrameMaker is set to generate bookmarks when saving as PDF. Set to False, otherwise.

PDFBookmarksOpenLevel

number

Denotes the level of bookmarks to be expanded when Acrobat opens the generated PDF document. The value can be any integer, or one of the following constants:

•Constants.FV_PDFBookmark­sOpenDefaultLevel (-1)

•Constants.FV_PDFBookmarksOpe­nAllLevels (-2)

•Constants.FV_PDFBookmark­sOpenNoneLevel (-3)

If you specify an integer that is greater than the number of levels in the Bookmarks Settings, the Constants.PDFBookmarksOpenAllLevels (-2) value takes effect.

PDFConvertCMYKtoRGB

number

When set to 1, the PDFConvertCMYKtoRGB property corresponds with the setting "Convert CMYK colors to RGB" in the Save As PDF dialog box.

PDFDestsMarked

number

Set to 1 if the document has paragraphs or elements marked through the MarkedForNamedDestination property.

One of two things must occur in order for this property to be True:

1. The document must have been created and opened in FrameMaker 6.0 or later.

2. The PDF FileSize Optimization client must have been run over it to mark all paragraphs or elements that are targets of hypertext links.

PDFDistillerAbsent

number

A value of 1 indicates that there is no Acrobat Distiller available. Any other value indicates that Acrobat Distiller is available.

PDFDocInfo

Strings

Contains a list of strings expressing values to be set in the PDF Document Info dictionary when you save the book as PDF. Each dictionary entry is expressed as a pair of strings; the first string expresses the field name, and the second string expresses the field value.

PDFEndPage

string

Denotes the last page in the range of pages to be printed, in the FrameMaker numbering style.

PDFJobOption

string

Specifies the name of the Distiller Job Options. If the specified name does not exist in the Distiller Job Options list, then the first Distiller Job Option in the list is used.

PDFJobOptionsAbsent

number

A value of 1 indicates that PDF Job Options are not available. Any other value indicates that PDF Job Options are available.

PDFOpenPage

string

Denotes the PDF page number, in the FrameMaker numbering style, at which Acrobat opens the generated PDF document.

PDFPageHeight

number

Denotes the page height for the generated PDF document.

PDFPageWidth

number

Indicates the page width for the generated PDF document.

PDFPrintPageRange

number

Specifies the page range for generating the PDF document. If set, the PDF file contains only the specified pages. Else, FrameMaker generates PDF for the entire document or book.

PDFRegistrationMarks

number

Contains the registration marks for the generated PDF. The permissible values are:

•Constants.FV_PDFRegistra­tionMarksNone (0)

•Constants.FV_PDFRegistra­tionMarksWestern (1)

•Constants.FV_PDFRegistra­tionMarksTombo (2)

PDFSeparateFiles

number

Set to 1, if a separate PDF file should be generated for each document in a book; Set to 0 otherwise. This property can be set for single documents, but is ignored in that case.

PDFStartPage

string

Denotes the first page of the printing page range, in the FrameMaker numbering style.

PDFZoomFactor

number

When the PDFZoomType property is set to Constants.FV_PDFZoomNone (0), the PDFZoomFactor property denotes the zoom percentage of the PDF document (metric 25% to 1600%). If the value is negative or zero, the value of Constants.FV_PDFZoomDefault (1) takes effect.

PDFZoomType

number

Denotes the PDF zoom setting at which Acrobat opens the generated PDF document. Permissible values are:

•Constants.FV_PDFZoomNone (0)

•Constants.FV_PDFZoomDe­fault (1)

•Constants.FV_PDFZoomPage (2)

•Constants.FV_PDFZoom­Width (3)

•Constants.FV_PDFZoom­Height (4)

If a value other than these is specified, Constants.FV_PDFZoomDefault (1) takes effect.

PDFAllNamedDestinations

number

Set to 1 if the generated PDF document should include Named Destinations for every paragraph and FrameMaker structure element in the book. This results in a larger PDF filesize.

If set to 0, the generated PDF document will have Named Destinations only for those paragraphs and objects that have already been marked with PDFDestsMarked set to True.

PrintBlankPages

number

Set to 1 if the PageRoundingproperty is set to allow empty pages at the end of documents; set to 0 otherwise.

PrintCollated

number

Set to 1 if Collate is enabled; Set to 0 otherwise.

PrintEmulsion

number

Denotes the direction of the print emulsion. The possible value are:

•Constants.FV_EMUL_UP (0) - Emulsion side up

•Constants.FV_EMUL_DOWN (1) - Emulsion side down

PrinterName

string

This property has no effect.

PrintEvenPages

number

Set to 1 if Print Even-Numbered Pages is enabled.

PrintFileName

string

Specifies the filename to print to. You can set the filename to be the default filename by specifying the PrintFileName value as null.

PrintImaging

number

Denotes the type of print imaging. The permissible values are:

•Constants.FV_IMG_POSITIVE (0)

•Constants.FV_IMG_NEGA­TIVE (1)

PrintLastSheetFirst

number

Set to 1 to print the last sheet first. Else, set to 0.

PrintLowRes

number

Set to 1 to print in low resolution. Else, set to 0.

PrintNumCopies

number

Denotes the number of copies to print.

PrintOddPages

number

Set to 1 if Print Odd-Numbered Pages is enabled.

PrintPaperHeight

number

Specifies the height of the printing paper.

PrintPaperWidth

number

Indicates the width of the printing paper.

PrintRegistrationMarks

number

Set to 1 if Registration Marks is enabled; Set to 0 otherwise.

PrintScale

number

Denotes the Print scale factor expressed as a percentage metric (0% to 100%).

For print scale percentages, the value 1<<16 or 0x10000 specifies 100%.

PrintSeps

number

Set to 1 if Print Separations is enabled.

PrintToFile

number

Set to 1 if Print Only to File is enabled.

SkipBlankSeps

number

Set to 1 if Skip Blank Separations (do not print blank color separations) is enabled.

CustomElementList

Strings

Contains the list of tags to display when ElementCatalogDisplay is set to Constants.FV_ELCAT_CUSTOM (0x04).

ElementCatalog

ElementCatalogEntries

Contains a list of elements in the Element Catalog.

ElementCatalogDisplay

number

Catalog display options. Show tags for:

•Constants.FV_ELCAT_STRICT (0x00): Valid children for working from start to finish.

•Constants.FV_ELCAT_LOOSE (0x01): Valid children for working in any order.

•Constants.FV_ELCAT_CHIL­DREN (0x02): Children allowed anywhere in parent.

•Constants.FV_ELCAT_ALL (0x03): All elements.

•Constants.FV_ELCAT_­CUSTOM (0x04): List of tags specified by the CustomElemen­tList property.

FileExtensionOverride

string

Denotes the filename extension to use when saving the document as XML. Typically, this property is used to save XHTML with a .htm extension rather than .xml. This setting should be set in the structure application for the document's DOCTYPE.

ElementSelection

ElementRange

Indicates the currently selected element range in the book.

FirstFmtChangeListInDoc

FmtChangeList

Specifies the ID of the first format change list in the list of format change lists in the book.

FirstElementDefInDoc

ElementDef

Denotes the first element definition in the list of element definitions in the document (FO_ElementDef ID).

HighestLevelElement

Element

Denotes the top most element for a structured book/document.

NewElemAttrDisplay

number

Specifies the attribute display properties for new elements. The permissible values are:

•Constants.FV_ATTR_DISP_­NONE (1): Do not display attri­butes.

•Constants.FV_AT­TR_DISP_REQSPEC (2): Display required and specified attributes.

•Constants.FV_AT­TR_DISP_ALL (3): Display all attributes.

NewElemAttrEditing

number

Specifies when the Edit Attributes dialog box appears for new elements. The permissible values are:

•Constants.FV_ATTR_EDIT_­NONE (0)

•Constants.FV_ATTR_EDIT_RE­QUIRED (1)

•Constants.FV_ATTR_EDIT_AL­WAYS (2)

SeparateInclusions

number

Set to 1 if inclusions are listed separately in the element catalog; set to 0 otherwise.

StructuredApplication

string

Contains the name of the structured application that is associated with the book. If the book has no associated structure application, GetString() returns an empty string.

UseInitialStructure

number

Set to 1 if FrameMaker inserts the initial structure for new elements; set to 0 otherwise.

XmlDocType

string

Contains the DOCTYPE parameter from the source XML.

XmlEncoding

string

Specifies the encoding parameter of the XML Declaration for the source XML. The string is empty if no encoding is specified. If this property is set, the XML Declaration contains the encoding parameter with this value on Save As XML.

XmlFileEncoding

string

Specifies the encoding that is detected for the source XML book. If no encoding is specified for the source XML, XmlEncoding is an empty string. In that case, if this value is set, it determines the encoding to use when saving as XML. If XmlEncoding has a value, this string may be empty.

XmlPublicId

string

Contains the DOCTYPE public identifier for the source XML document.

XmlStandAlone

number

Indicates an integer that specifies the XML standalone parameter for the XML document, that is the source of the current document. The permissible values are:

•Constants.FV_XML_STAND­ALONE_YES (1)

•Constants.FV_XML_STAND­ALONE_NO (2)

•Constants.FV_XML_STAND­ALONE_NONE (3)

•Constants.FV_XML_STAND­ALONE_NODEC (4)

The standalone parameter is declared in the XML Declaration. For a file with no XML declaration, the value is Constants.FV_XML_STANDALONE_NODEC (4). For an XML declaration with no standalone parameter, this value is Constants.FV_XML_STANDALONE_NONE (3).

XmlStyleSheet

string

Specifies the XML stylesheet processing instruction to write out to XML when saving the book as XML.

Note; The ESTK does not verify that you are using the correct syntax in this string.

The string you set should not include the PI delimiters, <? and ?>. For example, the string you supply for my.css may be:

"type=\"text\\css\" href=\"my.css\""

Only use this string to set a specific stylesheet specification. GetString() always returns null for this parameter. To get the list of stylesheet specifications associated with a book, use XmlStyleSheetList.

XmlStyleSheetList

Strings

Contains a list of stylesheet processing instructions for the current book. One book can have more than one stylesheet specification associated with it.

Note: The ESTK does not verify that you are using the correct syntax in these strings.

The strings should not include the PI delimiters, <? and ?>.

For example, the string you supply for my.css may be:

"type=\"text\\css\" href=\"my.css\""

Setting a list as the value to the XmlStyleSheetList property completely overwrites the preceding list.

XmlSystemId

string

Contains the DOCTYPE system identifier for the source XML document.

XmlUseBOM

number

Indicates whether a byte order mark was detected when opening the source XML. The permissible values are:

•Constants.FV_XML_USE­BOM_YES (1)

•Constants.FV_XML_USE­BOM_NO (2)

•Constants.FV_XML_USE­BOM_UTF8 (3)

•Constants.FV_XML_USE­BOM_UTF16BE (4)

•Constants.FV_XML_USE­BOM_UTF16LE (5)

•Constants.FV_XML_USE­BOM_UTF32BE (6)

•Constants.FV_XML_USE­BOM_UTF32LE (7)

When saving as XML, if this property is set to Constants.FV_XML_USEBOM_YES (1), FrameMaker writes a byte order mark in the resulting XML.

XmlVersion

string

Depicts the XML Version that is specified in the XML Declaration when the file is opened. If no XML version is specified, GetString() returns an empty string.

If this string contains an invalid XML declaration, a parsing error occurs when the book is saved as XML.

XmlWellFormed

number

Indicates whether the source XML is qualified as well formed. The permissible values are:

•Constants.FV_XML_WELL­FORMED_YES (1)

•Constants.FV_XML_WELL­FORMED_NO (2)

BookIsViewOnly

number

Set to 1 if the book is view-only; set to 0 otherwise.

ViewOnlyDeadCodes

UInts

Contains a list of F-codes that cannot be executed in the book.

ViewOnlyWinBorders

number

Set to 1 if the book has normal window borders; Set to 0 if the book's border buttons are suppressed.

ViewOnlyWinPopup

number

Set to 1 if the book window pop-up menu is available; set to 0 otherwise.

PDFGenerateForReview

number

This property is used to generate a PDF for review workflow that is getting review comments in PDF and importing them back to FrameMaker document.

The property helps in importing back the comments correctly. When this flag is turned ON, the behavior is same as if the "Generate for review only" checkbox is ON in the PDF setup dialog.

ShowElementDescriptiveNames

bool

Set to True to show descriptive names for elements; Set to False, otherwise.

note:    The ShowElementDescriptiveNames property is applicable only for structured FrameMaker.

UseInitialStructureOfAutoInsertedElements

bool

If set to True, auto-insertion rules will be processed recursively. For example: If an element is inserted automatically, and auto-insertion rules exist for this element, in the element definition, then those rules would also be processed.