Adobe FrameMaker-10 Object Model JS: Book

Framemaker 2010

Class

Book

 

QuickLinks

Close, Compare, Export, GetProps, GetUniqueObject, Import, NewBookComponentInHierarchy, NewBookComponentOfTypeInHierarchy, NewSeriesBookComponent, ObjectValid, Save, SetProps, SilentPrintDoc, SimpleGenerate, SimpleImportElementDefs, SimpleImportFormats, SimpleSave, UpdateBook

Properties

PropertyTypeAccessDescription
AcrobatBookmarkDisplayTagsint readwrite
BookDontUpdateReferencesint readwrite
BookIsModifiedint readonly
BookIsSelectedint readwrite
BookIsViewOnlyint readwrite
CustomElementListStrings readwrite
DocAcrobatColumnArticleThreadsint readwrite
DocAcrobatDefaultsChangedint readwrite
DocAcrobatElementListStrings readwrite
DocAcrobatElementsint readwrite
DocAcrobatNoArticleThreadsint readwrite
ElementCatalogElementCatalogEntries readonly
ElementCatalogDisplayint readwrite
ElementSelectionElementRange readwrite
FileExtensionOverridestring readwrite
FirstComponentInBookBookComponent readwrite
FirstElementDefInDocElementDef readonly
FirstFmtChangeListInDocFmtChangeList readwrite
FirstSelectedComponentInBookBookComponent readwrite
GenerateAcrobatInfoint readwrite
HighestLevelElementElement readonly
IsIconifiedint readwrite
IsInFrontint readwrite
IsOnScreenint readwrite
Labelstring readwrite
Namestring readwrite
NewElemAttrDisplayint readwrite
NewElemAttrEditingint readwrite
NextOpenBookInSessionBook readonly
PDFAllNamedDestinationsint readwrite
PDFBookmarkbool readwrite
PDFBookmarksOpenLevelint readwrite
PDFConvertCMYKtoRGBint readwrite
PDFDestsMarkedint readwrite
PDFDistillerAbsentint readonly
PDFDocInfoStrings readwrite
PDFEndPagestring readwrite
PDFGenerateForReviewint readwrite
PDFJobOptionstring readwrite
PDFJobOptionsAbsentint readonly
PDFOpenPagestring readwrite
PDFPageHeightint readwrite
PDFPageWidthint readwrite
PDFPrintPageRangeint readwrite
PDFRegistrationMarksint readwrite
PDFSeparateFilesint readwrite
PDFStartPagestring readwrite
PDFZoomFactorint readwrite
PDFZoomTypeint readwrite
PrintBlankPagesint readwrite
PrintCollatedint readwrite
PrintDownloadAsianFontsint readwrite
PrintDownloadTrueTypeAsType1int readwrite
PrintEmulsionint readwrite
PrintEvenPagesint readwrite
PrintFileNamestring readwrite
PrintImagingint readwrite
PrintLastSheetFirstint readwrite
PrintLowResint readwrite
PrintNumCopiesint readwrite
PrintOddPagesint readwrite
PrintPaperHeightint readwrite
PrintPaperWidthint readwrite
PrintRegistrationMarksint readwrite
PrintScaleint readwrite
PrintSepsint readwrite
PrintToFileint readwrite
PrinterNamestring readwrite
ScreenHeightint readwrite
ScreenWidthint readwrite
ScreenXint readwrite
ScreenYint readwrite
SeparateInclusionsint readwrite
SkipBlankSepsint readwrite
StatusLinestring readwrite
StructuredApplicationstring readwrite
TypeOfDisplayTextint readwrite
UseInitialStructureint readwrite
ViewOnlyDeadCodesUInts readwrite
ViewOnlyWinBordersint readwrite
ViewOnlyWinMenubarint readwrite
ViewOnlyWinPopupint readwrite
XmlDocTypestring readwrite
XmlEncodingstring readwrite
XmlFileEncodingstring readwrite
XmlPublicIdstring readwrite
XmlStandAloneint readwrite
XmlStyleSheetstring readwrite
XmlStyleSheetListStrings readwrite
XmlSystemIdstring readwrite
XmlUseBOMint readwrite
XmlVersionstring readwrite
XmlWellFormedint readwrite

Methods

Instances

int Close (flags: int)

ParameterTypeDescription
flagsint

CompareRet Compare (newerDoc: Doc, flags: int, insertCondTag: string, deleteCondTag: string, replaceText: string, compareThreshold: int)

ParameterTypeDescription
newerDocDoc
flagsint
insertCondTagstring
deleteCondTagstring
replaceTextstring
compareThresholdint

int Export (fileName: string, exportParams: PropVals, exportReturnParams: PropVals)

ParameterTypeDescription
fileNamestring
exportParamsPropVals
exportReturnParamsPropVals

PropVals GetProps ()

void GetUniqueObject (objType: int, unique: int)

ParameterTypeDescription
objTypeint
uniqueint

void Import (textLocP: TextLoc, filename: string, importParams: PropVals, importReturnParams: PropVals)

ParameterTypeDescription
textLocPTextLoc
filenamestring
importParamsPropVals
importReturnParamsPropVals

void NewBookComponentInHierarchy (compName: string, elemLoc: ElementLoc)

ParameterTypeDescription
compNamestring
elemLocElementLoc

void NewBookComponentOfTypeInHierarchy (compName: string, compType: int, elemLoc: ElementLoc)

ParameterTypeDescription
compNamestring
compTypeint
elemLocElementLoc

void NewSeriesBookComponent (previous: Any_Series_Object)

ParameterTypeDescription
previousAny_Series_Object

int ObjectValid ()

void Save (saveAsName: string, saveParams: PropVals, saveReturnParams: PropVals)

ParameterTypeDescription
saveAsNamestring
saveParamsPropVals
saveReturnParamsPropVals

void SetProps (setVal: PropVals)

ParameterTypeDescription
setValPropVals

int SilentPrintDoc ()

int SimpleGenerate (interactive: int, makeVisible: int)

ParameterTypeDescription
interactiveint
makeVisibleint

int SimpleImportElementDefs (fromDocOrBook: Doc, importFlags: int)

ParameterTypeDescription
fromDocOrBookDoc
importFlagsint

int SimpleImportFormats (fromDoc: Doc, formatFlags: int)

ParameterTypeDescription
fromDocDoc
formatFlagsint

void SimpleSave (saveAsName: string, interactive: int)

ParameterTypeDescription
saveAsNamestring
interactiveint

int UpdateBook (updateParams: PropVals, updateReturnParams: PropVals)

ParameterTypeDescription
updateParamsPropVals
updateReturnParamsPropVals

Element of

Book.NextOpenBookInSession

BookComponent.BookParent

app.ActiveBook

app.FirstOpenBook

Jongware, 31-Oct-2011 v3.0.3fContents :: Index