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

InDesign Server CS5

Class

Movies

 A collection of movies.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Movie [] (index: number)
Returns the Movie with the specified index.

ParameterTypeDescription
indexnumberThe index.

Movie add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new Movie

ParameterTypeDescription
layerLayerThe layer on which to create the Movie. (Optional)
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location at which to insert the Movie relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
referenceDocument
Layer
MasterSpread
Page
PageItem
Spread
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withPropertiesObjectInitial values for properties of the new Movie (Optional)

Movie anyItem ()
Returns any Movie in the collection.

number count ()
Displays the number of elements in the Movie.

Array of Movie everyItem ()
Returns every Movie in the collection.

Movie firstItem ()
Returns the first Movie in the collection.

Movie item (index: varies)
Returns the Movie with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

Movie itemByID (id: number)
Returns the Movie with the specified ID.

ParameterTypeDescription
idnumberThe ID.

Movie itemByName (name: string)
Returns the Movie with the specified name.

ParameterTypeDescription
namestringThe name.

Array of Movie itemByRange (from: varies, to: varies)
Returns the Movies within the specified range.

ParameterTypeDescription
fromLong Integer
Movie
String
The Movie, index, or name at the beginning of the range. Can accept: Movie, Long Integer or String.
toLong Integer
Movie
String
The Movie, index, or name at the end of the range. Can accept: Movie, Long Integer or String.

Movie lastItem ()
Returns the last Movie in the collection.

Movie middleItem ()
Returns the middle Movie in the collection.

Movie nextItem (obj: Movie)
Returns the Movie whose index follows the specified Movie in the collection.

ParameterTypeDescription
objMovieThe Movie whose index comes before the desired Movie.

Movie previousItem (obj: Movie)
Returns the Movie with the index previous to the specified index.

ParameterTypeDescription
objMovieThe index of the Movie that follows the desired Movie.

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

Element of

GraphicLine.movies

Oval.movies

Page.masterPageItems

Polygon.movies

Rectangle.movies

SplineItem.movies

Jongware, 23-Mar-2011 v3.0.3dContents :: Index