Article

An article

Methods:

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

Objects:

ArticleMembers, Boolean, EventListeners, Events, Number, Object, String

Property Listing

Property

Type

Access

Description

articleExportStatus

Boolean

read/write

The export status of the Article

articleMembers

ArticleMembers ArticleMember

readonly

A collection of article members.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

id

Number

readonly

The unique ID of the Article.

index

Number

readonly

The index of the Article within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

name

String

read/write

The name of the Article.

parent

Document

readonly

The parent of the Article (a Document).

properties

Object

read/write

A property that allows setting of several properties at the same time.

Method Listing

undefined addDocumentContent ()

Populates the article with all page items in the document.

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

Article getElements ()

Resolves the object specifier, creating an array of object references.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter

Type

Description

key

String

The key.

value

String

The value.

Article move (to:LocationOptions, reference:Article)

Moves the Article to the specified location.

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location relative to the reference object or within the containing object.

reference

Article

The reference object. Note: Required when the to value specifies before or after. (Optional)

undefined remove ()

Deletes the Article.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the Article.

String toSpecifier ()

Retrieves the object specifier.

Object of

FormField.allArticles

Button.allArticles

MultiStateObject.allArticles

CheckBox.allArticles

ComboBox.allArticles

ListBox.allArticles

RadioButton.allArticles

TextBox.allArticles

SignatureField.allArticles

Movie.allArticles

Sound.allArticles

PageItem.allArticles

Oval.allArticles

Rectangle.allArticles

GraphicLine.allArticles

Polygon.allArticles

Group.allArticles

Image.allArticles

EPS.allArticles

PDF.allArticles

WMF.allArticles

PICT.allArticles

Graphic.allArticles

SplineItem.allArticles

EPSText.allArticles

ImportedPage.allArticles

SVG.allArticles

MediaItem.allArticles

HtmlItem.allArticles

TextFrame.allArticles

EndnoteTextFrame.allArticles

ArticleMember.parent

Event.parent

EventListener.parent

MutationEvent.parent

Return

Articles.add()

Article.move()

Article.getElements()

Articles.anyItem()

Articles.everyItem()

Articles.nextItem()

Articles.previousItem()

Articles.itemByID()

Articles.item()

Articles.[]()

Articles.itemByName()

Articles.itemByRange()

Articles.firstItem()

Articles.lastItem()

Articles.middleItem()