An object library asset.
Go to Property Listing | Method Listing
remove, placeAsset, select, insertLabel, extractLabel, toSource, getElements, toSpecifier, addEventListener, removeEventListener
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
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 |
read/write |
The type of object library asset. |
|
date |
readonly |
The date and time the Asset was created. |
|
|
description |
read/write |
The description of the Asset. |
|
|
eventListeners |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
id |
readonly |
The unique ID of the Asset. |
|
|
index |
readonly |
The index of the Asset within its containing object. |
|
|
isValid |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
label |
read/write |
A property that can be set to any string. |
|
|
name |
read/write |
The name of the Asset. |
|
|
parent |
readonly |
The parent of the Asset (a Library). |
|
|
properties |
read/write |
A property that allows setting of several properties at the same time. |
EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
The key. |
Asset 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.
Varies placeAsset (on:Varies)
Places the asset in the specified document or text.
|
Parameter |
Type |
Description |
|---|---|---|
|
on |
Varies |
The document or text object in which to place the asset. Can accept: Document or Text. |
undefined remove ()
Deletes the Asset.
Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined select ([existingSelection:SelectionOptions=SelectionOptions])
Selects the object.
|
Parameter |
Type |
Description |
|---|---|---|
|
existingSelection |
SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH SelectionOptions.SET_KEY |
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.