Class

ListBoxes

 A collection of listboxes.

QuickLinks

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

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

ParameterTypeDescription
indexnumberThe index.

ListBox add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new ListBox

ParameterTypeDescription
layerLayerThe layer on which to create the ListBox. (Optional)
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location at which to insert the ListBox relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
referenceDocument
Layer
MasterSpread
Page
PageItem
Spread
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withPropertiesObjectInitial 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.

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objListBoxThe ListBox whose index comes before the desired ListBox.

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

ParameterTypeDescription
objListBoxThe index of the ListBox that follows the desired ListBox.

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

Element of

Cell.listBoxes

Character.listBoxes

Document.listBoxes

GraphicLine.listBoxes

Group.listBoxes

InsertionPoint.listBoxes

Layer.listBoxes

Line.listBoxes

MasterSpread.listBoxes

Oval.listBoxes

Page.listBoxes

Page.tabOrder

Paragraph.listBoxes

PlaceGun.listBoxes

Polygon.listBoxes

Rectangle.listBoxes

ShowHideFieldsBehavior.fieldsToHide

ShowHideFieldsBehavior.fieldsToShow

Snippet.listBoxes

SplineItem.listBoxes

Spread.listBoxes

Story.listBoxes

Table.listBoxes

Text.listBoxes

TextColumn.listBoxes

TextFrame.listBoxes

TextStyleRange.listBoxes

Word.listBoxes

XmlStory.listBoxes

Jongware, 28-Apr-2012 v3.0.3hContents :: Index