Adobe InCopy CS5 (7.0) Object Model JS: MediaItems

InCopy CS5

Class

MediaItems

 The media items collection.

QuickLinks

[], 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

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

ParameterTypeDescription
indexnumberThe index.

MediaItem anyItem ()
Returns any MediaItem in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objMediaItemThe MediaItem whose index comes before the desired MediaItem.

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

ParameterTypeDescription
objMediaItemThe index of the MediaItem that follows the desired MediaItem.

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

Element of

GraphicLine.mediaItems

Oval.mediaItems

Polygon.mediaItems

Rectangle.mediaItems

SplineItem.mediaItems

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