ListBoxes

A collection of listboxes.

Go to Property Listing | Method Listing

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

ListBox [] (index:Number)

Returns the ListBox with the specified index.

Parameter	Type	Description
index	Number	The index.

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

Creates a new ListBox

Parameter	Type	Description
layer	Layer	The layer on which to create the ListBox. (Optional)
at	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location at which to insert the ListBox 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 ListBox (Optional)

ListBox anyItem ()

Returns any ListBox in the collection.

Number count ()

Displays the number of elements in the ListBox.

ListBox everyItem ()

Returns every ListBox in the collection.

ListBox firstItem ()

Returns the first ListBox in the collection.

ListBox item (index:Varies LongInteger String)

Returns the ListBox with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

ListBox itemByID (id:Number)

Returns the ListBox with the specified ID.

Parameter	Type	Description
id	Number	The ID.

ListBox itemByName (name:String)

Returns the ListBox with the specified name.

Parameter	Type	Description
name	String	The name.

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

Returns the ListBoxes within the specified range.

Parameter	Type	Description
from	ListBox LongInteger String	The ListBox, index, or name at the beginning of the range. Can accept: ListBox, Long Integer or String.
to	ListBox LongInteger String	The ListBox, index, or name at the end of the range. Can accept: ListBox, Long Integer or String.

Parameter

Type

Description

from

ListBox

LongInteger

String

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

ListBox

LongInteger

String

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