K4 InDesign Javascript API Documentation

LayoutArticle

An article

Instance Properties

Name Description Access
articleExportStatus bool The export status of the Article read-write
articleMembers ArticleMembers A collection of article members. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the Article. read-only
index number The index of the Article within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the Article. read-write
parent Document The parent of the Article (a Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addDocumentContent(
)
addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → Article
insertLabel(
key, value)
move(
to ​[, reference])
  → Article
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addDocumentContent(
)
Populates the article with all page items in the document.
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(
)
  → Article
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.
move(
to ​[, reference])
  → Article
Moves the Article to the specified location.
to LocationOptions The location relative to the reference object or within the containing object.
reference Article The reference object. Note: Required when the to value specifies before or after. (Optional)
remove(
)
Deletes the Article.
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 Article.
toSpecifier(
)
  → string
Retrieves the object specifier.