Adobe InDesign CS5 (7.0) Object Model JS: DTD

previous page next page

Class

DTD

The document DTD. Base Class: XMLItem

DTD

Property	Type	Access	Description
contents	SpecialCharacters String	readonly	The contents of the text. Can return: String or SpecialCharacters enumerator.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
id	number	readonly	The unique ID of the DTD.
index	number	readonly	The index of the DTD within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
parent	Document	readonly	The parent of the DTD (a Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
publicId	string	readonly	The public ID of the DOCTYPE declaration. Note: Valid only when the DTD is an external subset.
rootTag	XMLTag	r/w	The tag of the root object.
systemId	string	readonly	The system ID of the DOCTYPE declaration. Note: Valid only when the DTD is an external subset.

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

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This 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.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

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

Parameter	Type	Description
existingSelection	SelectionOptions: 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.