InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

AssignedStory

An assigned story.

Hierarchy

Assignment

AssignedStory

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
String | File readonly The file path (colon delimited on the Mac OS). Can also accept: File.
Number readonly The unique ID of the AssignedStory.
Number readonly The index of the AssignedStory 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 AssignedStory.
Assignment readonly The parent of the AssignedStory (a Assignment).
Object read/write A property that allows setting of several properties at the same time.
Oval | PageItem | Rectangle | Story | Polygon readonly A reference to the assigned story. Can return: Story, PageItem, Oval, Rectangle or Polygon.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

Gets the label value associated with the specified key.

key String The key.
→ AssignedStory[]

Resolves the object specifier, creating an array of object references.

→ void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
→ AssignedStory

Moves the assigned story to the specified location.

to? LocationOptions The location of the assigned story relative to the reference object or within the containing object.
reference? Assignment | AssignedStory The reference object. Note: Required when the to parameter specifies before or after. Can accept: Assignment or AssignedStory.
→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

Generates a string which, if executed, will return the AssignedStory.

→ String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a AssignedStory.

Event.parentEventListener.parentMutationEvent.parent

Parameter of 4

Method parameters that accept a AssignedStory.

AssignedStories.itemByRange(from)AssignedStories.nextItem(obj)AssignedStories.previousItem(obj)AssignedStory.move(reference)

Return 14

Methods that return a AssignedStory.

AssignedStories.[]()AssignedStories.anyItem()AssignedStories.everyItem()AssignedStories.firstItem()AssignedStories.item()AssignedStories.itemByID()AssignedStories.itemByName()AssignedStories.itemByRange()AssignedStories.lastItem()AssignedStories.middleItem()AssignedStories.nextItem()AssignedStories.previousItem()AssignedStory.getElements()AssignedStory.move()