Class

Article

 An article

QuickLinks

addDocumentContent, addEventListener, extractLabel, getElements, insertLabel, move, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Document
Article
ArticleMember | Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
articleExportStatusbool r/wThe export status of the Article
articleMembersArticleMembers readonlyA collection of article members.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the Article.
indexnumber readonlyThe index of the Article within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the Article.
parentDocument readonlyThe parent of the Article (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

void addDocumentContent ()
Populates the article with all page items in the document.

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)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

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

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

Article move (to: LocationOptions[, reference: Article])
Moves the Article to the specified location.

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location relative to the reference object or within the containing object.
referenceArticleThe reference object. Note: Required when the to value specifies before or after. (Optional)

void remove ()
Deletes the Article.

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 Article.

string toSpecifier ()
Retrieves the object specifier.

Element of

ArticleMember.parent

Button.allArticles

CheckBox.allArticles

ComboBox.allArticles

EPS.allArticles

EPSText.allArticles

FormField.allArticles

Graphic.allArticles

GraphicLine.allArticles

Group.allArticles

HtmlItem.allArticles

Image.allArticles

ImportedPage.allArticles

ListBox.allArticles

MediaItem.allArticles

Movie.allArticles

MultiStateObject.allArticles

Oval.allArticles

PDF.allArticles

PICT.allArticles

PageItem.allArticles

Polygon.allArticles

RadioButton.allArticles

Rectangle.allArticles

SignatureField.allArticles

Sound.allArticles

SplineItem.allArticles

TextBox.allArticles

TextFrame.allArticles

WMF.allArticles

Used in:

Article Article.move (to: LocationOptions[, reference: Article])

Article Articles.add ([name: string][, articleExportStatus: bool][, at: LocationOptions=LocationOptions.AT_END][, reference: Article][, withProperties: Object])

Article Articles.nextItem (obj: Article)

Article Articles.previousItem (obj: Article)

Return

Array of Article Article.getElements ()

Article Article.move (to: LocationOptions[, reference: Article])

Article Articles.[] (index: number)

Article Articles.add ([name: string][, articleExportStatus: bool][, at: LocationOptions=LocationOptions.AT_END][, reference: Article][, withProperties: Object])

Article Articles.anyItem ()

Array of Article Articles.everyItem ()

Article Articles.firstItem ()

Article Articles.item (index: varies)

Article Articles.itemByID (id: number)

Article Articles.itemByName (name: string)

Array of Article Articles.itemByRange (from: varies, to: varies)

Article Articles.lastItem ()

Article Articles.middleItem ()

Article Articles.nextItem (obj: Article)

Article Articles.previousItem (obj: Article)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index