Adobe FrameMaker-12 Object Model JS: Book

FrameMaker 12.0

previous page next page

Class

Book

QuickLinks

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

Properties

Property	Type	Access
AcrobatBookmarkDisplayTags	int	readwrite
BookDontUpdateReferences	int	readwrite
BookIsModified	int	readonly
BookIsSelected	int	readwrite
BookIsViewOnly	int	readwrite
CustomElementList	Strings String	readwrite
DocAcrobatColumnArticleThreads	int	readwrite
DocAcrobatDefaultsChanged	int	readwrite
DocAcrobatElementList	Strings String	readwrite
DocAcrobatElements	int	readwrite
DocAcrobatNoArticleThreads	int	readwrite
ElementCatalog	ElementCatalogEntries ElementCatalogEntry	readonly
ElementCatalogDisplay	int	readwrite
ElementSelection	ElementRange	readwrite
FileExtensionOverride	string	readwrite
FirstComponentInBook	BookComponent	readwrite
FirstElementDefInDoc	ElementDef	readonly
FirstFmtChangeListInDoc	FmtChangeList	readwrite
FirstSelectedComponentInBook	BookComponent	readwrite
GenerateAcrobatInfo	int	readwrite
HighestLevelElement	Element	readonly
IsIconified	int	readwrite
IsInFront	int	readwrite
IsOnScreen	int	readwrite
Label	string	readwrite
Name	string	readwrite
NewElemAttrDisplay	int	readwrite
NewElemAttrEditing	int	readwrite
NextOpenBookInSession	Book	readonly
PDFAllNamedDestinations	int	readwrite
PDFBookmark	bool	readwrite
PDFBookmarksOpenLevel	int	readwrite
PDFConvertCMYKtoRGB	int	readwrite
PDFDestsMarked	int	readwrite
PDFDistillerAbsent	int	readonly
PDFDocInfo	Strings String	readwrite
PDFEndPage	string	readwrite
PDFGenerateForReview	int	readwrite
PDFJobOption	string	readwrite
PDFJobOptionsAbsent	int	readonly
PDFOpenPage	string	readwrite
PDFPageHeight	int	readwrite
PDFPageWidth	int	readwrite
PDFPrintPageRange	int	readwrite
PDFRegistrationMarks	int	readwrite
PDFSeparateFiles	int	readwrite
PDFStartPage	string	readwrite
PDFZoomFactor	int	readwrite
PDFZoomType	int	readwrite
PrintBlankPages	int	readwrite
PrintCollated	int	readwrite
PrintDownloadAsianFonts	int	readwrite
PrintDownloadTrueTypeAsType1	int	readwrite
PrintEmulsion	int	readwrite
PrintEvenPages	int	readwrite
PrintFileName	string	readwrite
PrintImaging	int	readwrite
PrintLastSheetFirst	int	readwrite
PrintLowRes	int	readwrite
PrintNumCopies	int	readwrite
PrintOddPages	int	readwrite
PrintPaperHeight	int	readwrite
PrintPaperWidth	int	readwrite
PrintRegistrationMarks	int	readwrite
PrintScale	int	readwrite
PrintSeps	int	readwrite
PrintToFile	int	readwrite
PrinterName	string	readwrite
ScreenHeight	int	readwrite
ScreenWidth	int	readwrite
ScreenX	int	readwrite
ScreenY	int	readwrite
SeparateInclusions	int	readwrite
ShowElementDescriptiveNames	bool	readwrite
SkipBlankSeps	int	readwrite
StatusLine	string	readwrite
StructuredApplication	string	readwrite
TypeOfDisplayText	int	readwrite
UseInitialStructure	int	readwrite
UseInitialStructureOfAutoInsertedElements	bool	readwrite
ViewOnlyDeadCodes	UInts	readwrite
ViewOnlyWinBorders	int	readwrite
ViewOnlyWinMenubar	int	readwrite
ViewOnlyWinPopup	int	readwrite
XmlDocType	string	readwrite
XmlEncoding	string	readwrite
XmlFileEncoding	string	readwrite
XmlPublicId	string	readwrite
XmlStandAlone	int	readwrite
XmlStyleSheet	string	readwrite
XmlStyleSheetList	Strings String	readwrite
XmlSystemId	string	readwrite
XmlUseBOM	int	readwrite
XmlVersion	string	readwrite
XmlWellFormed	int	readwrite

Methods

Instances

int Close (flags: int)

Parameter	Type	Description
flags	int

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

Parameter	Type	Description
newerDoc	Doc
flags	int
insertCondTag	string
deleteCondTag	string
replaceText	string
compareThreshold	int

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

Parameter	Type	Description
fileName	string
exportParams	PropVals
exportReturnParams	PropVals

TypedVals GetDependencies (depMode: int)

Parameter	Type	Description
depMode	int

PropVals GetProps ()

Object GetUniqueObject (objType: int, unique: int)

Parameter	Type	Description
objType	int
unique	int

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

Parameter	Type	Description
textLocP	TextLoc
filename	string
importParams	PropVals
importReturnParams	PropVals

Element NewBookComponentInHierarchy (compName: string, elemLoc: ElementLoc)

Parameter	Type	Description
compName	string
elemLoc	ElementLoc

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

Parameter	Type	Description
compName	string
compType	int
elemLoc	ElementLoc

Object NewIterator (paramsp: PropVals)

Parameter	Type	Description
paramsp	PropVals

BookComponent NewSeriesBookComponent (previous: Object)

Parameter	Type	Description
previous	Object

Object NewSeriesObject (objType: int, previous: Object)

Parameter	Type	Description
objType	int
previous	Object

int ObjectValid ()

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

Parameter	Type	Description
saveAsName	string
saveParams	PropVals
saveReturnParams	PropVals

void SetProps (setVal: PropVals)

Parameter	Type	Description
setVal	PropVals

int SilentPrintDoc ()

int SimpleGenerate (interactive: int, makeVisible: int)

Parameter	Type	Description
interactive	int
makeVisible	int

int SimpleImportElementDefs (fromDocOrBook: Doc|Book, importFlags: int)

Parameter	Type	Description
fromDocOrBook	Doc\|Book
importFlags	int

int SimpleImportFormats (fromDoc: Doc, formatFlags: int)

Parameter	Type	Description
fromDoc	Doc
formatFlags	int

Book SimpleSave (saveAsName: string, interactive: int)

Parameter	Type	Description
saveAsName	string
interactive	int

int UpdateBook (updateParams: PropVals, updateReturnParams: PropVals)

Parameter	Type	Description
updateParams	PropVals
updateReturnParams	PropVals

Element of

Book.NextOpenBookInSession

BookComponent.BookParent

app.ActiveBook

app.FirstOpenBook

Return

Book Book.SimpleSave (saveAsName: string, interactive: int)

Book app.GetNamedBook (name: string)

Book app.NewNamedBook (name: string)

Jongware, 18-Jan-2015 v1.0

Contents :: Index

previous page start next page