Adobe FrameMaker-12 Object Model JS: Globals

FrameMaker 12.0

Class

Globals

 

QuickLinks

AddMenu, Alert, Alive, AllocatePropVals, AppendIntProp, AppendMetricProp, AppendStringProp, AppendStringsProp, AppendVal, CMSAddMenuEntry, CMSGetCmsIdFromName, CMSLogin, CMSRegister, CallClient, CallClientEx, CheckStatus, ChooseFile, ClientDir, ClientName, ClientNumber, CustomDoc, DefineMenu, DisconnectFromSession, Emergency, Err, ErrorName, Externalize, FamilyFonts, FileScrollBox, GetEncodingForFamily, GetEncodingForFont, GetExportDefaultParams, GetFontAngleValue, GetFontFamilyValue, GetFontVariationValue, GetFontWeightValue, GetImportDefaultParams, GetIteratorDefaultParams, GetKeyCatalog, GetNewXMLDefaultParams, GetOpenDefaultParams, GetPropIndex, GetSaveDefaultParams, GetSupportedEncodings, GetUpdateBookDefaultParams, InitializationName, IsDRL, IsDataDifferentFromTemplateData, IsEncodingSupported, IsFileValid, LoadMenuCustomizationFile, LogFMPIPEvent, MenuExists, NewKeyCatalog, NewXML, Notification, NotificationName, Open, PopClipboard, PrintErrno, PrintExportStatus, PrintFAErrno, PrintImportStatus, PrintInitialization, PrintNotification, PrintOpenStatus, PrintPropVal, PrintPropVals, PrintSaveStatus, PrintTextItem, PrintTextItems, PrintUpdateBookStatus, PromptInt, PromptMetric, PromptString, PushClipboard, RemoveMenu, ReturnValue, Run, ScrollBox, Service, SetDdeInstance, ShortcutExists, ShutDown, SimpleNewDoc, SimpleOpen, Sleep, StringLen, USleep, UpdateMenus, UserCancel, WinInstallDefaultMessageFilter

Methods

Instances

int AddMenu (toMenu: string, menu: string, label: string)

ParameterTypeDescription
toMenustring
menustring
labelstring

int Alert (message: string, type: int)

ParameterTypeDescription
messagestring
typeint

int Alive (: void)

ParameterTypeDescription
void

PropVals AllocatePropVals (numProps: int)

ParameterTypeDescription
numPropsint

void AppendIntProp (pv: PropVals, prop: int, val: int)

ParameterTypeDescription
pvPropVals
propint
valint

void AppendMetricProp (pv: PropVals, prop: int, val: int)

ParameterTypeDescription
pvPropVals
propint
valint

void AppendStringProp (pv: PropVals, prop: int, val: string)

ParameterTypeDescription
pvPropVals
propint
valstring

void AppendStringsProp (pv: PropVals, prop: int, val: Strings)

ParameterTypeDescription
pvPropVals
propint
valStrings

void AppendVal (pv: PropVals, prop: int, val: TypedVal)

ParameterTypeDescription
pvPropVals
propint
valTypedVal

int CMSAddMenuEntry (menuId: int, menuEntryp: CMSMenuItem)

ParameterTypeDescription
menuIdint
menuEntrypCMSMenuItem

CMSRegistration CMSGetCmsIdFromName (cmsName: string)

ParameterTypeDescription
cmsNamestring

CMSSession CMSLogin (setVal: IdValuePairs)

ParameterTypeDescription
setValIdValuePairs

CMSRegistration CMSRegister (cmsName: string)

ParameterTypeDescription
cmsNamestring

int CallClient (clname: string, arg: string)

ParameterTypeDescription
clnamestring
argstring

TypedVals CallClientEx (clname: string, arg: string)

ParameterTypeDescription
clnamestring
argstring

int CheckStatus (p: PropVals, statusBit: int)

ParameterTypeDescription
pPropVals
statusBitint

int ChooseFile (title: string, directory: string, stuffVal: string, mode: int, helpLink: string)

ParameterTypeDescription
titlestring
directorystring
stuffValstring
modeint
helpLinkstring

string ClientDir (: void)

ParameterTypeDescription
void

string ClientName (_: void)

ParameterTypeDescription
_void

int ClientNumber (_: void)

ParameterTypeDescription
_void

Doc CustomDoc (width: int, height: int, numCols: int, columnGap: int, topMargin: int, botMargin: int, leftinsideMargin: int, rightoutsideMargin: int, sidedness: int, makeVisible: bool)

ParameterTypeDescription
widthint
heightint
numColsint
columnGapint
topMarginint
botMarginint
leftinsideMarginint
rightoutsideMarginint
sidednessint
makeVisiblebool

Menu DefineMenu (name: string, label: string)

ParameterTypeDescription
namestring
labelstring

int DisconnectFromSession ()

void Emergency (: void)

ParameterTypeDescription
void

void Err (message: string)

ParameterTypeDescription
messagestring

string ErrorName (i: int)

ParameterTypeDescription
iint

int Externalize (srcDocId: Object, objId: Object, dstFolder: string)

ParameterTypeDescription
srcDocIdObject
objIdObject
dstFolderstring

Fonts FamilyFonts (family: int)

ParameterTypeDescription
familyint

int FileScrollBox (title: string, directory: string)

ParameterTypeDescription
titlestring
directorystring

string GetEncodingForFamily (family: int)

ParameterTypeDescription
familyint

string GetEncodingForFont (font: Font)

ParameterTypeDescription
fontFont

PropVals GetExportDefaultParams (: void)

ParameterTypeDescription
void

int GetFontAngleValue (angleName: string)

ParameterTypeDescription
angleNamestring

int GetFontFamilyValue (familyName: string)

ParameterTypeDescription
familyNamestring

int GetFontVariationValue (variationName: string)

ParameterTypeDescription
variationNamestring

int GetFontWeightValue (weightName: string)

ParameterTypeDescription
weightNamestring

PropVals GetImportDefaultParams ()

PropVals GetIteratorDefaultParams ()

KeyCatalog GetKeyCatalog (tag: string)

ParameterTypeDescription
tagstring

PropVals GetNewXMLDefaultParams ()

PropVals GetOpenDefaultParams ()

int GetPropIndex (propVals: PropVals, propNum: int)

ParameterTypeDescription
propValsPropVals
propNumint

PropVals GetSaveDefaultParams ()

Strings GetSupportedEncodings ()

PropVals GetUpdateBookDefaultParams ()

string InitializationName (i: int)

ParameterTypeDescription
iint

bool IsDRL (drl: string)

ParameterTypeDescription
drlstring

bool IsDataDifferentFromTemplateData (templatePath: string, templateDataProps: PropVals)

ParameterTypeDescription
templatePathstring
templateDataPropsPropVals

bool IsEncodingSupported (encodingName: string)

ParameterTypeDescription
encodingNamestring

bool IsFileValid (docOrBookId: Object, silent: bool)

ParameterTypeDescription
docOrBookIdObject
silentbool

void LoadMenuCustomizationFile (pathname: string, silent: bool)

ParameterTypeDescription
pathnamestring
silentbool

int LogFMPIPEvent (category: string, subcategory: string, eventName: string)

ParameterTypeDescription
categorystring
subcategorystring
eventNamestring

int MenuExists (menu: string)

ParameterTypeDescription
menustring

KeyCatalog NewKeyCatalog (tag: string)

ParameterTypeDescription
tagstring

Object NewXML (newXMLParams: PropVals, newXMLReturnParamspp: PropVals)

ParameterTypeDescription
newXMLParamsPropVals
newXMLReturnParamsppPropVals

int Notification (notification: int, state: int)

ParameterTypeDescription
notificationint
stateint

string NotificationName (i: int)

ParameterTypeDescription
iint

Object Open (fileName: string, openParams: PropVals, openReturnParams: PropVals)

ParameterTypeDescription
fileNamestring
openParamsPropVals
openReturnParamsPropVals

int PopClipboard (: void)

ParameterTypeDescription
void

void PrintErrno (i: int)

ParameterTypeDescription
iint

void PrintExportStatus (p: PropVals)

ParameterTypeDescription
pPropVals

void PrintFAErrno (_: void)

ParameterTypeDescription
_void

void PrintImportStatus (p: PropVals)

ParameterTypeDescription
pPropVals

void PrintInitialization (i: int)

ParameterTypeDescription
iint

void PrintNotification (i: int)

ParameterTypeDescription
iint

void PrintOpenStatus (p: PropVals)

ParameterTypeDescription
pPropVals

void PrintPropVal (p: PropVal)

ParameterTypeDescription
pPropVal

void PrintPropVals (p: PropVals)

ParameterTypeDescription
pPropVals

void PrintSaveStatus (p: PropVals)

ParameterTypeDescription
pPropVals

void PrintTextItem (textItem: TextItem)

ParameterTypeDescription
textItemTextItem

void PrintTextItems (textItems: TextItems)

ParameterTypeDescription
textItemsTextItems

void PrintUpdateBookStatus (p: PropVals)

ParameterTypeDescription
pPropVals

int PromptInt (message: string, stuffVal: string)

ParameterTypeDescription
messagestring
stuffValstring

int PromptMetric (message: string, stuffVal: string, defaultunit: int)

ParameterTypeDescription
messagestring
stuffValstring
defaultunitint

int PromptString (message: string, stuffVal: string)

ParameterTypeDescription
messagestring
stuffValstring

void PushClipboard (: void)

ParameterTypeDescription
void

int RemoveMenu (fromMenu: string, label: string)

ParameterTypeDescription
fromMenustring
labelstring

int ReturnValue (retvalue: int)

ParameterTypeDescription
retvalueint

int Run (: void)

ParameterTypeDescription
void

int ScrollBox (title: string, stringslist: Strings, _default: int)

ParameterTypeDescription
titlestring
stringslistStrings
_defaultint

int Service ()

int SetDdeInstance (ddeInstance: int)

ParameterTypeDescription
ddeInstanceint

int ShortcutExists (shortcut: string)

ParameterTypeDescription
shortcutstring

void ShutDown (_: void)

ParameterTypeDescription
_void

Doc SimpleNewDoc (templateName: string, interactive: int)

ParameterTypeDescription
templateNamestring
interactiveint

Object SimpleOpen (fileName: string, interactive: int)

ParameterTypeDescription
fileNamestring
interactiveint

int Sleep (seconds: int)

ParameterTypeDescription
secondsint

int StringLen (s: string)

ParameterTypeDescription
sstring

int USleep (microseconds: int)

ParameterTypeDescription
microsecondsint

void UpdateMenus (: void)

ParameterTypeDescription
void

int UserCancel (: void)

ParameterTypeDescription
void

void WinInstallDefaultMessageFilter (: void)

ParameterTypeDescription
void

Jongware, 18-Jan-2015 v1.0Contents :: Index