Adobe InCopy CS5.5 (7.5) Object Model JS: DTD

InCopy CS5.5

Class

DTD

 The document DTD. Base Class: XMLItem

QuickLinks

addEventListener, getElements, remove, removeEventListener, select, toSource, toSpecifier

Hierarchy

Document
XMLItem
DTD
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
contentsSpecialCharactersString readonlyThe contents of the text. Can return: String or SpecialCharacters enumerator.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the DTD.
indexnumber readonlyThe index of the DTD within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentDocument readonlyThe parent of the DTD (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
publicIdstring readonlyThe public ID of the DOCTYPE declaration. Note: Valid only when the DTD is an external subset.
rootTagXMLTag r/wThe tag of the root object.
systemIdstring readonlyThe system ID of the DOCTYPE declaration. Note: Valid only when the DTD is an external subset.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of DTD getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the DTD.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.

ParameterTypeDescription
existingSelectionSelectionOptions:
SelectionOptions.ADD_TO
SelectionOptions.REMOVE_FROM
SelectionOptions.REPLACE_WITH
The selection status of the DTD in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

string toSource ()
Generates a string which, if executed, will return the DTD.

string toSpecifier ()
Retrieves the object specifier.

Used in:

DTD DTDs.nextItem (obj: DTD)

DTD DTDs.previousItem (obj: DTD)

Return

Array of DTD DTD.getElements ()

DTD DTDs.[] (index: number)

DTD DTDs.anyItem ()

Array of DTD DTDs.everyItem ()

DTD DTDs.firstItem ()

DTD DTDs.item (index: varies)

DTD DTDs.itemByID (id: number)

Array of DTD DTDs.itemByRange (from: varies, to: varies)

DTD DTDs.lastItem ()

DTD DTDs.middleItem ()

DTD DTDs.nextItem (obj: DTD)

DTD DTDs.previousItem (obj: DTD)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index