Class

AssignedStory

 An assigned story.

QuickLinks

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

Hierarchy

Assignment
AssignedStory
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
filePathFile
string
readonlyThe file path (colon delimited on the Mac OS). Can also accept: File.
idnumber readonlyThe unique ID of the AssignedStory.
indexnumber readonlyThe index of the AssignedStory within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the AssignedStory.
parentAssignment readonlyThe parent of the AssignedStory (a Assignment).
propertiesObject r/wA property that allows setting of several properties at the same time.
storyReferenceOval
PageItem
Polygon
Rectangle
Story
readonlyA reference to the assigned story. Can return: Story, PageItem, Oval, Rectangle or Polygon.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

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

ParameterTypeDescription
toLocationOptions:
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)
referenceAssignedStory
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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

AssignedStory AssignedStories.nextItem (obj: AssignedStory)

AssignedStory AssignedStories.previousItem (obj: AssignedStory)

Return

AssignedStory AssignedStories.[] (index: number)

AssignedStory AssignedStories.anyItem ()

Array of AssignedStory AssignedStories.everyItem ()

AssignedStory AssignedStories.firstItem ()

AssignedStory AssignedStories.item (index: varies)

AssignedStory AssignedStories.itemByID (id: number)

AssignedStory AssignedStories.itemByName (name: string)

Array of AssignedStory AssignedStories.itemByRange (from: varies, to: varies)

AssignedStory AssignedStories.lastItem ()

AssignedStory AssignedStories.middleItem ()

AssignedStory AssignedStories.nextItem (obj: AssignedStory)

AssignedStory AssignedStories.previousItem (obj: AssignedStory)

Array of AssignedStory AssignedStory.getElements ()

AssignedStory AssignedStory.move ([to: LocationOptions=LocationOptions.AT_END][, reference: varies])

Jongware, 28-Apr-2012 v3.0.3hContents :: Index