Adobe InDesign CS2 (4.0) Object Model JS: Movies

InDesign CS2

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 add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Create 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
Location (Optional) (default: LocationOptions.UNKNOWN)
referenceDocument
Layer
MasterSpread
Page
Spread
Before/after this Movie or at the beginning/end of this Document, Spread, Master Spread, Page or Layer. Can accept: Document, Spread, MasterSpread, Page or Layer. (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: any)
Returns the Movie with the specified index or name.

ParameterTypeDescription
indexLong
String
The index or name. Can accept: Long 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: any, to: any)
Returns the Movies within the specified range.

ParameterTypeDescription
fromLong
Movie
String
The Movie, index, or name at the beginning of the range. Can accept: Movie, Long or String.
toLong
Movie
String
The Movie, index, or name at the end of the range. Can accept: Movie, Long 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

Oval.movies

Page.masterPageItems

PageItem.movies

Polygon.movies

Rectangle.movies

Used in:

Asset Library.store (using: Array of any)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index