FlexObjects

A collection of flex objects.

Methods:

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

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

FlexObject [] (index:Number)

Returns the FlexObject with the specified index.

Parameter

Type

Description

index

Number

The index.

FlexObject add (flexDescription:String, destinationPage:Page, destinationLayer:Layer, placePoint:Array of Number String, withProperties:Object)

Creates a new flex object.

Parameter

Type

Description

flexDescription

String

The flex description to create the object from. (Optional)

destinationPage

Page

The page on which to create the object. (Optional)

destinationLayer

Layer

The layer on which to create the Object. Uses active document layer by default (Optional)

placePoint

Array of Number

Array of String

The point where to place the object (only applicable if page is provided) (Optional)

withProperties

Object

Initial values for properties of the new FlexObject (Optional)

FlexObject anyItem ()

Returns any FlexObject in the collection.

Number count ()

Displays the number of elements in the FlexObject.

FlexObject everyItem ()

Returns every FlexObject in the collection.

FlexObject firstItem ()

Returns the first FlexObject in the collection.

FlexObject item (index:Varies LongInteger String)

Returns the FlexObject with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

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

FlexObject itemByID (id:Number)

Returns the FlexObject with the specified ID.

Parameter

Type

Description

id

Number

The ID.

FlexObject itemByName (name:String)

Returns the FlexObject with the specified name.

Parameter

Type

Description

name

String

The name.

FlexObject itemByRange (from:Varies FlexObject LongInteger String, to:Varies FlexObject LongInteger String)

Returns the FlexObjects within the specified range.

Parameter

Type

Description

from

FlexObject

LongInteger

String

The FlexObject, index, or name at the beginning of the range. Can accept: FlexObject, Long Integer or String.

to

FlexObject

LongInteger

String

The FlexObject, index, or name at the end of the range. Can accept: FlexObject, Long Integer or String.

FlexObject lastItem ()

Returns the last FlexObject in the collection.

FlexObject middleItem ()

Returns the middle FlexObject in the collection.

FlexObject nextItem (obj:FlexObject)

Returns the FlexObject whose index follows the specified FlexObject in the collection.

Parameter

Type

Description

obj

FlexObject

The FlexObject whose index comes before the desired FlexObject.

FlexObject previousItem (obj:FlexObject)

Returns the FlexObject with the index previous to the specified index.

Parameter

Type

Description

obj

FlexObject

The index of the FlexObject that follows the desired FlexObject.

String toSource ()

Generates a string which, if executed, will return the FlexObject.

Object of

Document.flexObjects

FormField.flexObjects

Button.flexObjects

MultiStateObject.flexObjects

CheckBox.flexObjects

ComboBox.flexObjects

ListBox.flexObjects

RadioButton.flexObjects

TextBox.flexObjects

SignatureField.flexObjects

Movie.flexObjects

Sound.flexObjects

Spread.flexObjects

Page.flexObjects

MasterSpread.flexObjects

PageItem.flexObjects

Oval.flexObjects

Rectangle.flexObjects

GraphicLine.flexObjects

Polygon.flexObjects

Group.flexObjects

Image.flexObjects

EPS.flexObjects

PDF.flexObjects

WMF.flexObjects

PICT.flexObjects

Graphic.flexObjects

SplineItem.flexObjects

EPSText.flexObjects

ImportedPage.flexObjects

SVG.flexObjects

MediaItem.flexObjects

FlexObject.flexObjects

HtmlItem.flexObjects

TextFrame.flexObjects

EndnoteTextFrame.flexObjects