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

InDesign Server CS5

Class

Images

 A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).

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

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

ParameterTypeDescription
indexnumberThe index.

Image anyItem ()
Returns any Image in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromImage
Long Integer
String
The Image, index, or name at the beginning of the range. Can accept: Image, Long Integer or String.
toImage
Long Integer
String
The Image, index, or name at the end of the range. Can accept: Image, Long Integer or String.

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

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

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

ParameterTypeDescription
objImageThe Image whose index comes before the desired Image.

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

ParameterTypeDescription
objImageThe index of the Image that follows the desired Image.

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

Element of

Button.images

GraphicLine.images

Movie.images

MultiStateObject.images

Oval.images

PlaceGun.images

Polygon.images

Rectangle.images

Snippet.images

Sound.images

SplineItem.images

State.images

XMLElement.images

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