An object library asset.
Go to Property Listing | Method Listing
addEventListener, extractLabel, getElements, insertLabel, placeAsset, remove, removeEventListener, select, toSource, toSpecifier
Property |
Type |
Access |
Description |
---|---|---|---|
read/write |
The type of object library asset. |
||
readonly |
The date and time the Asset was created. |
||
read/write |
The description of the Asset. |
||
readonly |
A collection of event listeners. |
||
readonly |
A collection of events. |
||
readonly |
The unique ID of the Asset. |
||
readonly |
The index of the Asset within its containing object. |
||
readonly |
Returns true if the object specifier resolves to valid objects. |
||
read/write |
A property that can be set to any string. |
||
read/write |
The name of the Asset. |
||
readonly |
The parent of the Asset (a Library). |
||
read/write |
A property that allows setting of several properties at the same time. |
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The event type. |
|
handler |
JavaScriptFunction |
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 Document Text)
Places the asset in the specified document or text.
Parameter |
Type |
Description |
---|---|---|
on |
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 File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The registered event type. |
|
handler |
JavaScriptFunction |
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 |
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.