Article
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| articleExportStatus | bool | r/w | 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 | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the Article. |
| parent | Document | readonly | The parent of the Article (a Document). |
| properties | Object | r/w | A 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.
| 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) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The 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.
| 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.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING 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) |
void remove ()
Deletes the Article.
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) |
string toSource ()
Generates a string which, if executed, will return the Article.
Element of
ArticleMember.parent
Button.allArticles
EPS.allArticles
EPSText.allArticles
FormField.allArticles
Graphic.allArticles
GraphicLine.allArticles
Group.allArticles
Image.allArticles
ImportedPage.allArticles
MediaItem.allArticles
Movie.allArticles
MultiStateObject.allArticles
Oval.allArticles
PDF.allArticles
PICT.allArticles
PageItem.allArticles
Polygon.allArticles
Rectangle.allArticles
Sound.allArticles
SplineItem.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.3i | Contents :: Index |