K4 InDesign Javascript API Documentation

XMLXMLComment

An XML comment.

Extends

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 XMLComment. read-only
index number The index of the XMLComment within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the XMLComment (a Document or XMLElement). read-only
properties Object A property that allows setting of several properties at the same time. read-write
storyOffset InsertionPoint The insertion point before the table in the story containing the table. read-only
value string The text of the XML comment. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
duplicate(
)
  → XMLComment
getElements(
)
  → XMLComment
move(
to, reference)
  → XMLComment
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
select(
[existingSelection])
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)
duplicate(
)
  → XMLComment
Duplicates the XMLComment.
getElements(
)
  → XMLComment
Resolves the object specifier, creating an array of object references.
move(
to, reference)
  → XMLComment
Moves the element to the specified location.
to LocationOptions The location in relation to the reference object or within the containing object.
reference The reference object. Note: Required when the to parameter specifies before or after. . Can accept: XMLItem or Text. (Optional)
remove(
)
Deletes the XMLComment.
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)
select(
[existingSelection=SelectionOptions.REPLACE_WITH])
Selects the object.
existingSelection SelectionOptions The selection status of the XMLComment in relation to previously selected objects. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the XMLComment.
toSpecifier(
)
  → string
Retrieves the object specifier.