Adds an event listener.The handler can also be the path of a .jsx file as a string — that script runs as ExtendScript when the event fires.
Not available in UXP — require("indesign") does not export this object. ExtendScript only.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| EventListeners |
readonly | A collection of event listeners. | |
| Events |
readonly | A collection of events. | |
| Number | readonly | generated image id | |
| String | readonly | Optional image metadata string | |
| String | readonly | Low proxy image as base64. | |
| Number | readonly | generated image seed | |
| String | readonly | generated image uri | |
| Number | readonly | The unique ID of the GenAIImage. | |
| Number | readonly | The index of the GenAIImage within its containing object. | |
| Boolean | readonly | Returns true if the object specifier resolves to valid objects. | |
| String | read/write | A property that can be set to any string. | |
| String | read/write | The name of the GenAIImage; this is an alias to the GenAIImage's label property. | |
| GenAIModel | readonly | The parent of the GenAIImage (a GenAIModel). | |
| Object | read/write | A property that allows setting of several properties at the same time. |
Methods
→ String
Gets the label value associated with the specified key.
→ GenAIImage[]
Resolves the object specifier, creating an array of object references.
→ void
Sets the label to the value associated with the specified key.
→ void
Deletes the GenAIImage.
→ Boolean
Removes the event listener.
→ String
Generates a string which, if executed, will return the GenAIImage.
→ String
Retrieves the object specifier.
Object of 3
Properties elsewhere that hold a GenAIImage.
Parameter of 3
Method parameters that accept a GenAIImage.
Return 14
Methods that return a GenAIImage.
GenAIImage.getElements()GenAIImages.[]()GenAIImages.add()GenAIImages.anyItem()GenAIImages.everyItem()GenAIImages.firstItem()GenAIImages.item()GenAIImages.itemByID()GenAIImages.itemByName()GenAIImages.itemByRange()GenAIImages.lastItem()GenAIImages.middleItem()GenAIImages.nextItem()GenAIImages.previousItem()