K4 InDesign Javascript API Documentation

K4 DocumentK4ServerData

K4 Server Data

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 K4ServerData within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
k4AvailableAsTemplate bool K4 Available As Template read-only
k4DesignName string K4 Design Name read-only
k4FileExtension string K4 File Extension read-only
k4FileVersionIndex number K4 File Version Index read-only
k4HasDesign bool K4 Has Design read-only
k4Id string K4 Server ID read-only
k4IsPreferredDesign bool K4 Is Preferred Design read-only
k4IssueId string K4 Issue ID read-only
k4IssueName string K4 Issue Name read-only
k4MetaDataValues K4MetaDataValues K4 Meta Data Values read-only
k4Name string K4 Name read-only
k4ObjectType K4ObjectType K4 Object Type read-only
k4OutputChannelName string K4 Output Channel Name read-only
k4Position number K4 position read-only
k4PublicationId string K4 Publication ID read-only
k4PublicationName string K4 Publication Name read-only
k4SectionId string K4 Section ID read-only
k4SectionName string K4 Section Name read-only
k4StatusId string K4 Status ID read-only
k4StatusName string K4 Status Name read-only
k4StatusPosition number K4 Status Position read-only
k4Tasks K4Tasks K4 Tasks read-only
k4VariantId string K4 Variant ID read-only
k4WfChannelId string K4 Workflow Channel ID read-only
k4WfDefinitionId string K4 Workflow Definition ID read-only
k4WfName string K4 Workflow Name read-only
k4WfObjectType K4WfObjectType K4 Workflow Object Type read-only
k4WfObjectVariantId string K4 Workflow Object Variant ID read-only
k4WorkflowActive bool K4 Workflow Active read-only
parent The parent of the K4ServerData (a Document, EPS, GraphicLine, Image, K4Article, Movie, Oval, PDF, PICT, Polygon, Rectangle, Sound, Story, XmlStory, WMF or K4ObjectWithTasks). 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(
)
  → K4ServerData
k4GetFinishTaskObject(
)
  → K4FinishTaskObject
k4GetTasks(
)
k4SaveVersion(
[k4VersionNote])
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(
)
  → K4ServerData
Resolves the object specifier, creating an array of object references.
k4GetFinishTaskObject(
)
  → K4FinishTaskObject
K4 Get Finish Task Object
k4GetTasks(
)
K4 Get Tasks
k4SaveVersion(
[k4VersionNote])
K4 Save Version
k4VersionNote string K4 Version Note (Optional)
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 K4ServerData.
toSpecifier(
)
  → string
Retrieves the object specifier.