Adobe InCopy CS6 (8.0) Object Model JS: ValidationError

InCopy CS6

Class

ValidationError

 An XML validation error.

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Document
ValidationError
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
attributeNamestring readonlyThe attribute name if the validation error refers to an attribute.
elementXMLElement readonlyThe element that caused the validation error.
errorMessagestring readonlyThe validation error message.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
indexnumber readonlyThe index of the ValidationError within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentDocument readonlyThe parent of the ValidationError (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.

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 ValidationError getElements ()
Resolves the object specifier, creating an array of object references.

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)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

ValidationError ValidationErrors.nextItem (obj: ValidationError)

ValidationError ValidationErrors.previousItem (obj: ValidationError)

Return

Array of ValidationError ValidationError.getElements ()

ValidationError ValidationErrors.[] (index: number)

ValidationError ValidationErrors.anyItem ()

Array of ValidationError ValidationErrors.everyItem ()

ValidationError ValidationErrors.firstItem ()

ValidationError ValidationErrors.item (index: varies)

Array of ValidationError ValidationErrors.itemByRange (from: varies, to: varies)

ValidationError ValidationErrors.lastItem ()

ValidationError ValidationErrors.middleItem ()

ValidationError ValidationErrors.nextItem (obj: ValidationError)

ValidationError ValidationErrors.previousItem (obj: ValidationError)

Array of ValidationError XMLElement.validate ([maximumErrors: number=250])

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