K4 InDesign Javascript API Documentation

K4 ServerK4FinishTaskDialogObject

K4 Finish Task Dialog 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 K4FinishTaskDialogObject within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
k4AfterDialogObjects K4AfterDialogObjects K4 After Dialog Objects read-only
k4BeforeDialogObjects K4BeforeDialogObjects K4 Before Dialog Objects read-only
k4CancelExecution bool K4 Cancel Execution read-write
k4CancelMessage string K4 Cancel Message read-write
k4Document Document K4 Document read-only
parent Application The parent of the K4FinishTaskDialogObject (a Application). 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(
)
  → K4FinishTaskDialogObject
k4GetDialogObjects(
)
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(
)
  → K4FinishTaskDialogObject
Resolves the object specifier, creating an array of object references.
k4GetDialogObjects(
)
K4 Get Dialog Objects
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 K4FinishTaskDialogObject.
toSpecifier(
)
  → string
Retrieves the object specifier.