K4 InDesign Javascript API Documentation

K4 DocumentK4Article

K4 Article

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the K4Article. read-only
index number The index of the K4Article within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
k4FileVersionIndex number K4 File Version Index read-only
k4Id string K4 Server ID read-only
k4Name string K4 Name read-write
k4ObjectLabel string K4 Object Label read-only
k4ObjectState K4ObjectState K4 Object State 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
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
label string A property that can be set to any string. read-write
name string The name of the K4Article; this is an alias to the K4Article's label property. read-write
parent Document The parent of the K4Article (a Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → K4Article
insertLabel(
key, value)
k4AttachObject(
k4Id)
k4AttachObjectInDocument(
object)
k4DetachObject(
k4Id)
k4DetachObjectInDocument(
object)
k4GetDocument(
)
  → Document
k4GetObjectById(
k4Id)
  → Object
k4GetObjectByName(
k4Name)
  → Object
k4GetObjects(
)
  → Object
k4GetServerData(
)
  → K4ServerData
k4LinkTextObjectToOtherObject(
k4TextObjectId, k4OtherObjectId)
k4MoveChildToPosition(
k4ChildObjectId, k4InsertDirection ​[, k4TargetObjectId])
k4Revoke(
)
k4SwitchVariant(
k4Id)
k4UnlinkTextObjectFromOtherObject(
k4TextObjectId, k4OtherObjectId)
k4Update(
)
remove(
)
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)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → K4Article
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
k4AttachObject(
k4Id)
K4 Attach Object On Server
k4Id string K4 ID
k4AttachObjectInDocument(
object)
K4 Attach an Object in the document to an Article
object Story Object
k4DetachObject(
k4Id)
K4 Detach Object On Server
k4Id string K4 ID
k4DetachObjectInDocument(
object)
K4 Detach an Object in Document from an Article
object Story Object to separate
k4GetDocument(
)
  → Document
K4 Get Document
k4GetObjectById(
k4Id)
  → Object
K4 Get Object By ID
k4Id string K4 ID
k4GetObjectByName(
k4Name)
  → Object
K4 Get Object By Name
k4Name string K4 Name
k4GetObjects(
)
  → Object
K4 Get Objects
k4GetServerData(
)
  → K4ServerData
K4 Get Server Data
k4LinkTextObjectToOtherObject(
k4TextObjectId, k4OtherObjectId)
K4 Link Text Object To Other Object
k4TextObjectId string K4 Text Object ID
k4OtherObjectId string K4 Other Object ID
k4MoveChildToPosition(
k4ChildObjectId, k4InsertDirection ​[, k4TargetObjectId])
K4 Move Child To Position
k4ChildObjectId string K4 Child Object ID
k4InsertDirection K4InsertDirection K4 Insert Direction
k4TargetObjectId string K4 Target Object ID (Optional)
k4Revoke(
)
K4 Revoke
k4SwitchVariant(
k4Id)
K4 Switch Variant
k4Id string K4 ID
k4UnlinkTextObjectFromOtherObject(
k4TextObjectId, k4OtherObjectId)
K4 Unlink Text Object From Other Object
k4TextObjectId string K4 Text Object ID
k4OtherObjectId string K4 Other Object ID
k4Update(
)
K4 Update
remove(
)
Deletes the K4Article.
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 K4Article.
toSpecifier(
)
  → string
Retrieves the object specifier.