K4 InDesign Javascript API Documentation

K4 ServerK4Variant

K4 Variant

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 K4Variant within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
k4Abbreviation string K4 Abbreviation read-only
k4DefaultId string K4 Default ID read-only
k4Id string K4 Server ID 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
parent K4Publication The parent of the K4Variant (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(
)
  → K4Variant
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(
)
  → K4Variant
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 K4Variant.
toSpecifier(
)
  → string
Retrieves the object specifier.