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 |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
ListBox [] (index:Number)
Returns the ListBox with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
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 |
The layer on which to create the ListBox. (Optional) |
|
|
at |
The location at which to insert the ListBox relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN) |
|
|
reference |
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) |
|
|
withProperties |
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 |
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 |
The ID. |
ListBox itemByName (name:String)
Returns the ListBox with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
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 |
LongInteger |
The ListBox, index, or name at the beginning of the range. Can accept: ListBox, Long Integer or String. |
|
to |
LongInteger |
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.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The ListBox whose index comes before the desired ListBox. |
ListBox previousItem (obj:ListBox)
Returns the ListBox with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the ListBox that follows the desired ListBox. |
String toSource ()
Generates a string which, if executed, will return the ListBox.
Object of
PlaceGun.listBoxes
Document.listBoxes
Layer.listBoxes
Spread.listBoxes
Page.listBoxes
MasterSpread.listBoxes
Oval.listBoxes
Rectangle.listBoxes
GraphicLine.listBoxes
Polygon.listBoxes
Group.listBoxes
SplineItem.listBoxes
Snippet.listBoxes
Cell.listBoxes
Table.listBoxes
Text.listBoxes
Character.listBoxes
Word.listBoxes
Line.listBoxes
TextColumn.listBoxes
Paragraph.listBoxes
TextStyleRange.listBoxes
InsertionPoint.listBoxes
TextFrame.listBoxes
Story.listBoxes
EndnoteTextFrame.listBoxes
XmlStory.listBoxes
ShowHideFieldsBehavior.fieldsToHide
Page.tabOrder
ShowHideFieldsBehavior.fieldsToShow