K4 InDesign Javascript API Documentation

K4 ServerK4MetaDataDef

K4 Meta data definition

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the K4MetaDataDef within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
k4ColumnWidth number K4 Column Width read-only
k4DataId number K4 Data ID read-only
k4DefaultShown bool K4 Default Shown read-only
k4Id string K4 Server ID read-only
k4MetaDataDataType K4MetaDataDataType K4 Meta Data Data Type read-only
k4MetaDataDefColors K4MetaDataDefColors K4 Meta Data Def Colors read-only
k4MetaDataDefValueLists K4MetaDataDefValueLists K4 Meta Data Def Value Lists read-only
k4MetaDataUIType K4MetaDataUIType K4 Meta Data UI Type read-only
k4Name string K4 Name read-only
k4Position number K4 position read-only
k4PublicationId string K4 Publication ID read-only
k4ToBeDeleted bool K4 To Be Deleted read-only
k4ValidatorType K4MetaDataValidatorType K4 Validator Type read-only
k4ValidatorValue1 string K4 Validator Value1 read-only
k4ValidatorValue2 string K4 Validator Value2 read-only
k4Visible bool K4 Visible read-only
parent K4Publication The parent of the K4MetaDataDef (a K4Publication). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → K4MetaDataDef
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → K4MetaDataDef
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the K4MetaDataDef.
toSpecifier(
)
  → string
Retrieves the object specifier.