AssignedStory

Methods:

addEventListener, extractLabel, getElements, insertLabel, move, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, File, Number, Object, Oval, PageItem, Polygon, Rectangle, Story, String,

Property Listing

Property	Type	Access	Description
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
filePath	String File	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	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
name	String	read/write	The name of the AssignedStory.
parent	Assignment	readonly	The parent of the AssignedStory (a Assignment).
properties	Object	read/write	A property that allows setting of several properties at the same time.
storyReference	Oval PageItem Rectangle Story Polygon	readonly	A reference to the assigned story. Can return: Story, PageItem, Oval, Rectangle or Polygon.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

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

Parameter	Type	Description
key	String	The key.
value	String	The value.

AssignedStory move ([to:LocationOptions=LocationOptions], reference:Varies Assignment AssignedStory)

Moves the assigned story to the specified location.

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

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location of the assigned story relative to the reference object or within the containing object. (Optional)

(default: LocationOptions.AT_END)

reference

Assignment

AssignedStory

The reference object. Note: Required when the to parameter specifies before or after. Can accept: Assignment or AssignedStory. (Optional)

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
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. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean