Adobe FrameMaker-12 Object Model JS: KeyCatalog

FrameMaker 12.0

Class

KeyCatalog

 

QuickLinks

Delete, DeleteAllKeyDefinitions, GetAllKeyDefinitions, GetAllKeys, GetKeyDefinition, GetProps, NewKeyDefinition, ObjectValid, SetProps, UpdateKeyDefinition

Properties

PropertyTypeAccessDescription
IsDefaultbool readonly
IsStalebool readwrite
KeyCatalogClientNamestring readwrite
KeyCountint readonly
Namestring readwrite
NextKeyCatalogInSessionKeyCatalog readonly
NotLoadedbool readwrite
Sourcestring readwrite
SourceTypeint readwrite

Methods

Instances

int Delete ()

void DeleteAllKeyDefinitions ()

TypedVals GetAllKeyDefinitions (filterType: int)

ParameterTypeDescription
filterTypeint

Strings GetAllKeys ()

TypedVal GetKeyDefinition (key: string, keyField: int)

ParameterTypeDescription
keystring
keyFieldint

PropVals GetProps ()

void NewKeyDefinition (key: string, href: string, srcType: int, srcFile: string, flags: int)

ParameterTypeDescription
keystring
hrefstring
srcTypeint
srcFilestring
flagsint

int ObjectValid ()

void SetProps (setVal: PropVals)

ParameterTypeDescription
setValPropVals

void UpdateKeyDefinition (key: string, keyField: int, valuep: TypedVal)

ParameterTypeDescription
keystring
keyFieldint
valuepTypedVal

Element of

Doc.KeyCatalog

Doc.SpecifiedKeyCatalog

KeyCatalog.NextKeyCatalogInSession

app.DefaultKeyCatalog

app.FirstKeyCatalogInSession

Return

KeyCatalog Globals.GetKeyCatalog (tag: string)

KeyCatalog Globals.NewKeyCatalog (tag: string)

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