ComboBoxes

A collection of comboboxes.

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

ComboBox [] (index:Number)

Returns the ComboBox with the specified index.

Parameter

Type

Description

index

Number

The index.

ComboBox add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document Layer MasterSpread Page Spread PageItem, withProperties:Object)

Creates a new ComboBox

Parameter

Type

Description

layer

Layer

The layer on which to create the ComboBox. (Optional)

at

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location at which to insert the ComboBox relative to the reference object or within the container object. (Optional)

(default: LocationOptions.UNKNOWN)

reference

Document

Layer

MasterSpread

Page

Spread

PageItem

The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)

withProperties

Object

Initial values for properties of the new ComboBox (Optional)

ComboBox anyItem ()

Returns any ComboBox in the collection.

Number count ()

Displays the number of elements in the ComboBox.

ComboBox everyItem ()

Returns every ComboBox in the collection.

ComboBox firstItem ()

Returns the first ComboBox in the collection.

ComboBox item (index:Varies LongInteger String)

Returns the ComboBox with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

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

ComboBox itemByID (id:Number)

Returns the ComboBox with the specified ID.

Parameter

Type

Description

id

Number

The ID.

ComboBox itemByName (name:String)

Returns the ComboBox with the specified name.

Parameter

Type

Description

name

String

The name.

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

Returns the ComboBoxes within the specified range.

Parameter

Type

Description

from

ComboBox

LongInteger

String

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

to

ComboBox

LongInteger

String

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

ComboBox lastItem ()

Returns the last ComboBox in the collection.

ComboBox middleItem ()

Returns the middle ComboBox in the collection.

ComboBox nextItem (obj:ComboBox)

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

Parameter

Type

Description

obj

ComboBox

The ComboBox whose index comes before the desired ComboBox.

ComboBox previousItem (obj:ComboBox)

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

Parameter

Type

Description

obj

ComboBox

The index of the ComboBox that follows the desired ComboBox.

String toSource ()

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

Object of

PlaceGun.comboBoxes

Document.comboBoxes

Layer.comboBoxes

Spread.comboBoxes

Page.comboBoxes

MasterSpread.comboBoxes

Oval.comboBoxes

Rectangle.comboBoxes

GraphicLine.comboBoxes

Polygon.comboBoxes

Group.comboBoxes

SplineItem.comboBoxes

Snippet.comboBoxes

Cell.comboBoxes

Table.comboBoxes

Text.comboBoxes

Character.comboBoxes

Word.comboBoxes

Line.comboBoxes

TextColumn.comboBoxes

Paragraph.comboBoxes

TextStyleRange.comboBoxes

InsertionPoint.comboBoxes

TextFrame.comboBoxes

Story.comboBoxes

EndnoteTextFrame.comboBoxes

XmlStory.comboBoxes

ShowHideFieldsBehavior.fieldsToHide

Page.tabOrder

ShowHideFieldsBehavior.fieldsToShow