Adobe InDesign CS5 Server (7.0) Object Model JS: AssignedStory

previous page next page

Class

AssignedStory

An assigned story.

AssignedStory

Property	Type	Access	Description
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
filePath	string	readonly	The file path (colon delimited on the Mac OS). Can also accept: File.
id	number	readonly	The unique ID of the AssignedStory.
index	number	readonly	The index of the AssignedStory 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 AssignedStory.
parent	Assignment	readonly	The parent of the AssignedStory (a Assignment).
properties	Object	r/w	A property that allows setting of several properties at the same time.
storyReference	Oval PageItem Polygon Rectangle Story	readonly	A reference to the assigned story. Can return: Story, PageItem, Oval, Rectangle or Polygon.

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 AssignedStory 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.

AssignedStory move ([to: LocationOptions=LocationOptions.AT_END][, reference: varies])
Moves the assigned story to the specified location.

Parameter	Type	Description
to	LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN	The location of the assigned story relative to the reference object or within the containing object. (Optional) (default: LocationOptions.AT_END)
reference	AssignedStory Assignment	The reference object. Note: Required when the to parameter specifies before or after. Can accept: Assignment or AssignedStory. (Optional)

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)