|
Property name |
Data Type |
Description |
|---|---|---|
|
BookComponentIsGeneratable |
number |
Set to 1 if the book component is a generated file (BookComponentType is not set to Constants.FV_BK_NOT_GENERATABLE (16)); set to 0, otherwise. |
|
BookComponentType |
number |
Depicts the type of the book component. The possible values are: •Constants.FV_BK_TOC (0) - Table of contents. •Constants.FV_BK_LIST_FIGURE (1) - List of figures. •Constants.FV_BK_LIST_TABLE (2) - List of tables. •Constants.FV_BK_LIST_PGF (3) - List of paragraphs. •Constants.FV_BK_LIST_MARKER (4) - List of markers. •Constants.FV_BK_LIST_MARKER_ALPHA (5) - Alphabetical list of markers. •Constants.FV_BK_LIST_PGF_ALPHA (6) - Alphabetical list of paragraphs. •Constants.FV_BK_INDEX_STAN (7) - Standard index •Constants.FV_BK_INDEX_AUTHOR (8) - Index of authors. •Constants.FV_BK_INDEX_SUBJECT (9) - Subject index. •Constants.FV_BK_INDEX_MARKER (10) - Index of markers. •Constants.FV_BK_LIST_FORMATS (11) - List of formats •Constants.FV_BK_LIST_REFERENCES (12) - List of references. •Constants.FV_BK_INDEX_FORMATS (13) - Index of formats. •Constants.FV_BK_INDEX_REFERENCES (14) - Index of references. •Constants.FV_BK_NOT_GENERATABLE (16) - Book component is not a generated file. |
|
BookParent |
Specifies the book that contains the component (Constants.FO_BookID). |
|
|
ChapNumComputeMethod |
number |
The component document's chapter numbering type. The possible values are: •Constants.FV_NUM_READ_FROM_FILE (0x00) - Use the numbering properties from the document associated with this book component. •Constants.FV_NUM_CONTINUE (0x01) - Continue numbering from the previous chapter. •Constants.FV_NUM_RESTART (0x02) - Use the value specified for the ChapterNumber property. •Constants.FV_NUM_SAME (0x03) - Use the same chapter number as for the previous file. |
|
ChapterNumber |
number |
If the ChapNumComputeMethod property is set to Constants.FV_NUM_RESTART (0x02), use the ChapterNumberproperty as the chapter number. |
|
ChapterNumStyle |
number |
Denotes the chapter numbering style. The possible value are: •Constants.FV_NUMSTYLE_NUMERIC (0x00) - Arabic •Constants.FV_NUMSTYLE_ROMAN_UC (0x01) - Roman, uppercase •Constants.FV_NUMSTYLE_ROMAN_LC (0x02)- Roman,lowercase •Constants.FV_NUMSTYLE_ALPHA_UC (0x03) - Alphabetic, uppercase •Constants.FV_NUMSTYLE_ALPHA_LC (0x04) - Alphabetic, lowercase •Constants.FV_NUMSTYLE_KANJI (0x05) - Kanji •Constants.FV_NUMSTYLE_ZENKAKU (0x06) - Zenkaku •Constants.FV_NUMSTYLE_ZENKAKU_UC (0x07) - Zenkaku, uppercase •Constants.FV_NUMSTYLE_ZENKAKU_LC (0x08) - Zenkaku, lowercase •Constants.FV_NUMSTYLE_KANJI_KAZU (0x09) - Kazu •Constants.FV_NUMSTYLE_DAIJI (0x0a) - Daiji •Constants.FV_NUMSTYLE_TEXT (0x0b)- Text. This property is only for volume/chapter numbers. |
|
ChapterNumText |
string |
If the ChapNumStyle property is set to Constants.FV_NUMSTYLE_TEXT (0x0b), use the string specified in the ChapterNumText property as the chapter number. |
|
ComponentDisplayText |
string |
Specifies the text that displays in the book window when the value of the TypeOfDisplayText property is set to Constants.FV_BK_TEXT (2). Set the ComponentDisplayText property to an empty string ("") to allow FrameMaker to automatically update the text line with normal information. |
|
ComponentIsSelected |
number |
Set to 1 if the component is selected in the book window; otherwise set to 0. |
|
ExtractTags |
List of paragraph tags or markers type names that are used to set up a generatable file (for example, table of contents, list of figures, standard index or index of authors). |
|
|
FirstPageNum |
number |
Number for the first page in the component; used when the PageNumComputeMethod property is set to Constants.FV_NUM_RESTART (0x02). |
|
FnFirstNum |
string |
Number for the first footnote in the component; used when the FnNumComputeMethod property is set to Constants.FV_NUM_RESTART (0x02). |
|
FnCustNumString |
string |
Indicates the characters for custom document footnote numbers. |
|
FnNumStyle |
number |
Footnote numbering style. The possible values are: •Constants.FV_FN_NUM_NUMERIC (0x00) - Arabic •Constants.FV_FN_NUM_ROMAN_UC (0x01) - Roman uppercase •Constants.FV_FN_NUM_ROMAN_LC (0x02) - Roman lowercase •Constants.FV_FN_NUM_ALPHA_UC (0x03) - Alphabetic uppercase •Constants.FV_FN_NUM_ALPHA_LC (0x04) - Alphabetic lowercase •Constants.FV_FN_NUM_CUSTOM (0x05) - Custom numbering •Constants.FV_FN_NUM_KANJI (0x06) - Kanji characters •Constants.FV_FN_NUM_ZENKAKU (0x07) - Zenkaku •Constants.FV_FN_NUM_ZENKAKU_UC (0x08) - Zenkaku uppercase •Constants.FV_FN_NUM_ZENKAKU_LC (0x09) - Zenkaku lowercase •Constants.FV_FN_NUM_KANJI_KAZU (0x0A) - Kazu •Constants.FV_FN_NUM_DAIJI (0x0B) - Daiji |
|
FnNumComputeMethod |
number |
The component document's footnote numbering type. The possible values are: •Constants.FV_NUM_READ_FROM_FILE (0x00) - Use the numbering properties from the document associated with this book component. •Constants.FV_NUM_CONTINUE (0x01) - Continue numbering from the previous file. •Constants.FV_NUM_RESTART (0x02) - Use the number specified by the FnFirstNum property. •Constants.FV_NUM_PER_PAGE (0x03) - Restart numbering on each page. |
|
GenerateInclude |
number |
Set to 1 if the document appears in the scroll list of files to be generated by the Generate/Update command for the book; otherwise set to 0. |
|
ImportFmtInclude |
number |
Set to 1 if the book component is included in the list of components to be updated with imported formats or element definitions, when the user or a client executes Import Formats or Import Element Definitions; otherwise set to 0. |
|
InsertLinks |
number |
Set to 1 if hypertext links are automatically inserted in generated files; otherwise set to 0. |
|
Name |
string |
Indicates the path of the document that the component represents. |
|
NextComponentInBook |
Specifies the next component in the book file. |
|
|
NextSelectedComponentInBook |
Specifies the next selected component in the book window. |
|
|
PageNumComputeMethod |
number |
The component document's page numbering type. The possible values are: •Constants.FV_NUM_READ_FROM_FILE (0x00) - Use the numbering properties from the document associated with this book component. •Constants.FV_NUM_CONTINUE (0x01) - Continue the numbering from the previous file. •Constants.FV_NUM_RESTART (0x02) - Restart numbering at the value specified by the FirstPageNum property. |
|
PageNumStyle |
number |
Page numbering style. The possible values are: •Constants.FV_PAGE_NUM_NUMERIC (0x00) - Arabic •Constants.FV_PAGE_NUM_ROMAN_UC (0x01) - Roman uppercase •Constants.FV_PAGE_NUM_ROMAN_LC (0x02) - Roman lowercase •Constants.FV_PAGE_NUM_ALPHA_UC (0x03) - Alphabetic uppercase •Constants.FV_PAGE_NUM_ALPHA_LC (0x04) - Alphabetic lowercase •Constants.FV_PAGE_NUM_KANJI (0x05) - Kanji characters •Constants.FV_PAGE_NUM_ZENKAKU (0x06) - Zenkaku •Constants.FV_PAGE_NUM_ZENKAKU_UC (0x07) - Zenkaku uppercase •Constants.FV_PAGE_NUM_ZENKAKU_LC (0x08) - Zenkaku lowercase •Constants.FV_PAGE_NUM_KANJI_KAZU (0x09) - Kazu •Constants.FV_PAGE_NUM_DAIJI (0x0a) - Daiji |
|
PageSide |
number |
Specifies the page side on which to start the component document. The possible values are: •Constants.FV_BK_START_FROM_FILE (0x01) •Constants.FV_BK_START_NEXT_AVAILABLE (0x02) •Constants.FV_BK_START_LEFT (0x03) •Constants.FV_BK_START_RIGHT (0x04) |
|
PgfNumComputeMethod |
number |
The type of numbering for the component document's paragraph. Possible values are: •Constants.FV_NUM_READ_FROM_FILE (0x00) - Use the numbering properties from the document associated with this book component. •Constants.FV_NUM_CONTINUE (0x01) - Continue the numbering from the previous file. •Constants.FV_NUM_RESTART (0x02) - Restart numbering at 1. |
|
PrevComponentInBook |
Denotes the previous component in the book file. |
|
|
PrintInclude |
number |
Set to 1 if the component document is included in the list of book files to be printed; otherwise set to 0. |
|
TblFnCustNumString |
string |
Specifies the characters for custom table footnote numbers. |
|
TblFnNumStyle |
number |
Table footnote numbering style. The possible values are: •Constants.FV_FN_NUM_NUMERIC (0x00) - Arabic •Constants.FV_FN_NUM_ROMAN_UC (0x01) - Roman uppercase •Constants.FV_FN_NUM_ROMAN_LC (0x02) - Roman lowercase •Constants.FV_FN_NUM_ALPHA_UC (0x03) - Alphabetic uppercase •Constants.FV_FN_NUM_ALPHA_LC (0x04) - Alphabetic lowercase •Constants.FV_FN_NUM_CUSTOM (0x05)- Custom numbering •Constants.FV_FN_NUM_KANJI (0x06) - Kanji characters •Constants.FV_FN_NUM_ZENKAKU (0x07) - Zenkaku •Constants.FV_FN_NUM_ZENKAKU_UC (0x08) - Zenkaku uppercase •Constants.FV_FN_NUM_ZENKAKU_LC (0x09) - Zenkaku lowercase •Constants.FV_FN_NUM_KANJI_KAZU (0x0A) - Kazu •Constants.FV_FN_NUM_DAIJI (0x0B) - Daiji |
|
TblFnNumComputeMethod |
number |
The numbering type of the component document's table footnote. Possible values are: •Constants.FV_NUM_READ_FROM_FILE (0x00) - Use the numbering properties from the document associated with this book component. •Constants.FV_NUM_RESTART (0x02) - Start at 1. |
|
Unique |
number |
Represents the Unique ID of the book component. |
|
VolNumComputeMethod |
number |
The component document's volume numbering type. The possible values are: •Constants.FV_NUM_READ_FROM_FILE (0x00) - Use the numbering properties from the document associated with this book component. •Constants.FV_NUM_CONTINUE (0x01) - Continue numbering from the previous volume. •Constants.FV_NUM_RESTART (0x02) - Use the value specified for the VolumeNumber property. •Constants.FV_NUM_SAME (0x03) - Use the same volume number as for the previous file. |
|
VolumeNumber |
number |
If the VolNumComputeMethod property is set to Constants.FV_NUM_RESTART (0x02), use the value specified in the VolumeNumber property as the volume number. |
|
VolumeNumStyle |
number |
The volume numbering style. The possible values are: •Constants.FV_NUMSTYLE_NUMERIC (0x00) - Arabic •Constants.FV_NUMSTYLE_ROMAN_UC (0x01) - Roman uppercase •Constants.FV_NUMSTYLE_ROMAN_LC (0x02) - Roman lowercase •Constants.FV_NUMSTYLE_ALPHA_UC (0x03) - Alphabetic uppercase •Constants.FV_NUMSTYLE_ALPHA_LC (0x04) - Alphabetic lowercase •Constants.FV_NUMSTYLE_KANJI (0x05) - Kanji •Constants.FV_NUMSTYLE_ZENKAKU (0x06) - Zenkaku •Constants.FV_NUMSTYLE_ZENKAKU_UC (0x07) - Zenkaku uppercase •Constants.FV_NUMSTYLE_ZENKAKU_LC (0x08) - Zenkaku lowercase •Constants.FV_NUMSTYLE_KANJI_KAZU (0x09) - Kazu •Constants.FV_NUMSTYLE_DAIJI (0x0a) - Daiji •Constants.FV_NUMSTYLE_TEXT (0x0b) - Text |
|
VolumeNumText |
string |
If the VolNumStyle property is set to Constants.FV_NUMSTYLE_TEXT (0x0b), use the string specified in the VolumeNumText property as the chapter number. |
|
ComponentElement |
Specifies the component element (FO_Element ID). |
|
|
ExtractElementTags |
List of element tags that are used to set up a generatable file (for example, table of contents, list of figures, or list of tables). |
|
|
FirstComponentInBookComponent |
Denotes the first component of the hierarchy for which the current component is the parent. |
|
|
BookComponentParent |
Denotes the parent of the current book element. |
|
|
ExcludeBookComponent |
number |
Specifies the component to exclude when printing the book. |
|
BookComponentTemplatePath |
string |
The path to the file that is used as a template for a folder. |
|
BookComponentTitle |
string |
The name of a folder or a group component. |
|
ComponentType |
number |
Indicates whether the component is a folder, group, or a document. The value is one of: •Constants.FV_BK_FOLDER (0x02) - Folder •Constants.FV_BK_GROUP (0x40) - Group •Constants.FV_BK_FM (0x8) - FrameMaker document •Constants.FV_BK_MIF (0x10) - MIF document •Constants.FV_BK_XML (0x20) - XML document |
|
XmlApplicationForBookComponent |
string |
The application name for the XML that is set as template for the folder. |
|
SecNumComputeMethod |
number |
Indicates the type of numbering applied to a particular book component. The value is one of: •Constants.FV_NUM_CONTINUE (0x01) •Constants.FV_NUM_RESTART (0x02) •Constants.FV_NUM_SAME (0x03) |
|
SectionNumStyle |
number |
Denotes the section numbering style. Possible values are: •Constants.FV_PAGE_NUM_NUMERIC (0x00) - Arabic •Constants.FV_PAGE_NUM_ROMAN_UC (0x01) - Roman uppercase •Constants.FV_PAGE_NUM_ROMAN_LC (0x02) - Roman lowercase •Constants.FV_PAGE_NUM_ALPHA_UC (0x03) - Alphabetic uppercase •Constants.FV_PAGE_NUM_ALPHA_LC (0x04) - Alphabetic lowercase •Constants.FV_PAGE_NUM_KANJI (0x05) - Kanji characters •Constants.FV_PAGE_NUM_ZENKAKU (0x06) - Zenkaku •Constants.FV_PAGE_NUM_ZENKAKU_UC (0x07) - Zenkaku uppercase •Constants.FV_PAGE_NUM_ZENKAKU_LC (0x08) - Zenkaku lowercase •Constants.FV_PAGE_NUM_KANJI_KAZU (0x09) - Kazu •Constants.FV_PAGE_NUM_DAIJI (0x0a) - Daiji |
|
SectionNumber |
number |
Denotes the section number of the specified component. |
|
SectionNumText |
string |
The text to use for the SectionNumber property. |
|
SubsecNumComputeMethod |
number |
Indicates the type of numbering applied to a particular book component. The value is one of: •Constants.FV_NUM_CONTINUE (0x01) •Constants.FV_NUM_RESTART (0x02) •Constants.FV_NUM_SAME (0x03) |
|
SubsectionNumStyle |
number |
Denotes the subsection numbering style. Possible values are: •Constants.FV_PAGE_NUM_NUMERIC (0x00) - Arabic •Constants.FV_PAGE_NUM_ROMAN_UC (0x01) - Roman uppercase •Constants.FV_PAGE_NUM_ROMAN_LC (0x02) - Roman lowercase •Constants.FV_PAGE_NUM_ALPHA_UC (0x03) - Alphabetic uppercase •Constants.FV_PAGE_NUM_ALPHA_UC (0x03) - Alphabetic uppercase •Constants.FV_PAGE_NUM_ALPHA_LC (0x04) - Alphabetic lowercase •Constants.FV_PAGE_NUM_KANJI (0x05) - Kanji characters •Constants.FV_PAGE_NUM_ZENKAKU (0x06) - Zenkaku •Constants.FV_PAGE_NUM_ZENKAKU_UC (0x07) - Zenkaku uppercase •Constants.FV_PAGE_NUM_ZENKAKU_LC (0x08) - Zenkaku lowercase •Constants.FV_PAGE_NUM_KANJI_KAZU (0x09) - Kazu •Constants.FV_PAGE_NUM_DAIJI (0x0a) - Daiji |
|
SubsectionNumber |
number |
Denotes the subsection number of the specified component. |
|
SubsectionNumText |
string |
The text to use for the SubsectionNumber property. |
|
NextBookComponentInDFSOrder |
Denotes the pointer to traverse through book components in a hierarchal manner (top to bottom). |
|
|
BookComponentFileType |
number |
Determines the file type of the document. The possible values are: •Constants.FV_BK_FM (0x8) - FrameMaker document •Constants.FV_BK_MIF (0x10) - MIF document •Constants.FV_BK_XML (0x20) - XML document •Constants.FV_BK_XML (0x20) - Ditamap |
|
PrevBookComponentInDFSOrder |
Denotes the pointer to traverse through book components in an heirarchial manner (bottom to top). |
|
|
BookComponentIsFolderWithTemplate |
number |
Determines whether a template is associated with a book. Returns 1 if the BookComponent is a folder and a template is associated with the component. Returns 0, otherwise. |
|
BookComponentIsFolderWithoutTemplate |
number |
Determines whether a template is not associated with a book. Returns 1 if the BookComponent is a folder and a template is not associated. Returns 0 otherwise. |
|
ComponentIsDitaMap |
bool |
Determines whether a book component is a ditamap. Set to 1 if the book component is a ditamap; set to 0 otherwise. |