Asset
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| assetType | AssetType: AssetType.IMAGE_TYPE AssetType.EPS_TYPE AssetType.PDF_TYPE AssetType.GEOMETRY_TYPE AssetType.PAGE_TYPE AssetType.TEXT_TYPE AssetType.STRUCTURE_TYPE AssetType.INDESIGN_FILE_TYPE |
r/w | The type of object library asset. |
| date | Date | readonly | The date and time the Asset was created. |
| description | string | r/w | The description of the Asset. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| id | number | readonly | The unique ID of the Asset. |
| index | number | readonly | The index of the Asset 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 Asset. |
| parent | Library | readonly | The parent of the Asset (a Library). |
| properties | Object | r/w | A 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.
| 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 Asset 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. |
Array of any placeAsset (on:
varies)
Places the asset in the specified document or text.
| Parameter | Type | Description |
|---|---|---|
| on | Document Text | The document or text object in which to place the asset. Can accept: Document or Text. |
void remove ()
Deletes the Asset.
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 Asset in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH) |
string toSource ()
Generates a string which, if executed, will return the Asset.
string toSpecifier ()
Retrieves the object specifier.
Used in:
Asset Assets.nextItem (obj: Asset)
Asset Assets.previousItem (obj: Asset)
Return
Array of Asset Asset.getElements ()
Asset Assets.[] (index: number)
Asset Assets.anyItem ()
Array of Asset Assets.everyItem ()
Asset Assets.firstItem ()
Asset Assets.item (index: varies)
Asset Assets.itemByID (id: number)
Asset Assets.itemByName (name: string)
Array of Asset Assets.itemByRange (from: varies, to: varies)
Asset Assets.lastItem ()
Asset Assets.middleItem ()
Asset Assets.nextItem (obj: Asset)
Asset Assets.previousItem (obj: Asset)
Asset Button.store (using: Library[, withProperties: Object])
Asset EPS.store (using: Library[, withProperties: Object])
Asset EPSText.store (using: Library[, withProperties: Object])
Asset FormField.store (using: Library[, withProperties: Object])
Asset Graphic.store (using: Library[, withProperties: Object])
Asset GraphicLine.store (using: Library[, withProperties: Object])
Asset Group.store (using: Library[, withProperties: Object])
Asset Image.store (using: Library[, withProperties: Object])
Asset ImportedPage.store (using: Library[, withProperties: Object])
Asset Library.store (using: Array of varies[, withProperties: Object])
Asset MediaItem.store (using: Library[, withProperties: Object])
Asset Movie.store (using: Library[, withProperties: Object])
Asset MultiStateObject.store (using: Library[, withProperties: Object])
Asset Oval.store (using: Library[, withProperties: Object])
Asset PDF.store (using: Library[, withProperties: Object])
Asset PICT.store (using: Library[, withProperties: Object])
Asset PageItem.store (using: Library[, withProperties: Object])
Asset Polygon.store (using: Library[, withProperties: Object])
Asset Rectangle.store (using: Library[, withProperties: Object])
Asset Sound.store (using: Library[, withProperties: Object])
Asset SplineItem.store (using: Library[, withProperties: Object])
Asset TextFrame.store (using: Library[, withProperties: Object])
Asset WMF.store (using: Library[, withProperties: Object])
Asset XMLElement.store (using: Library[, withProperties: Object])
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |