K4 InDesign Javascript API Documentation

K4 ServerK4StartWorkflowObject

K4 Start Workflow Object

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 K4StartWorkflowObject 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-write
k4DeleteLocalFile bool K4 Delete Local File read-write
k4DesignName string K4 Design Name read-write
k4FilePath string K4 File Path read-write
k4IssueId string K4 Issue ID read-write
k4KeepThisVersion bool K4 Keep This Version read-write
k4MetaDataValues K4MetaDataValues K4 Meta Data Values read-only
k4Name string K4 Name read-write
k4NextTaskChanges K4NextTaskChanges K4 Next Task Changes read-only
k4PublicationId string K4 Publication ID read-only
k4SectionId string K4 Section ID read-write
k4Uid number K4 UID read-write
k4VariantId string K4 Variant ID read-write
k4VersionNote string K4 Version Note read-write
k4WfChannelId string K4 Workflow Channel ID read-only
k4WfId string K4 Workflow ID read-only
k4WorkflowActive bool K4 Workflow Active read-write
parent K4WorkflowChannel The parent of the K4StartWorkflowObject (a K4WorkflowChannel). 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(
)
  → K4StartWorkflowObject
k4BeginStartWorkflow(
)
k4EndStartWorkflow(
)
  → string
k4Update(
)
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(
)
  → K4StartWorkflowObject
Resolves the object specifier, creating an array of object references.
k4BeginStartWorkflow(
)
K4 Begin Start Workflow
k4EndStartWorkflow(
)
  → string
K4 End Start Workflow
k4Update(
)
K4 Update
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 K4StartWorkflowObject.
toSpecifier(
)
  → string
Retrieves the object specifier.