K4 InDesign Javascript API Documentation

XMLDTD

The document DTD.

Extends

Instance Properties

Name Description Access
contents The contents of the text. Can return: String or SpecialCharacters enumerator. 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 DTD. read-only
index number The index of the DTD within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent Document The parent of the DTD (a Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
publicId string The public ID of the DOCTYPE declaration. Note: Valid only when the DTD is an external subset. read-only
rootTag XMLTag The tag of the root object. read-write
systemId string The system ID of the DOCTYPE declaration. Note: Valid only when the DTD is an external subset. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → DTD
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)
getElements(
)
  → DTD
Resolves the object specifier, creating an array of object references.
remove(
)
Deletes the DTD.
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 DTD in relation to previously selected objects. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the DTD.
toSpecifier(
)
  → string
Retrieves the object specifier.