Adobe InCopy CS6 (8.0) Object Model JS: ComboBoxes

InCopy CS6

Class

ComboBoxes

 A collection of comboboxes.

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

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

ParameterTypeDescription
indexnumberThe index.

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

ParameterTypeDescription
layerLayerThe layer on which to create the ComboBox. (Optional)
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location at which to insert the ComboBox 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 ComboBox (Optional)

ComboBox anyItem ()
Returns any ComboBox in the collection.

number count ()
Displays the number of elements in the ComboBox.

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromComboBox
Long Integer
String
The ComboBox, index, or name at the beginning of the range. Can accept: ComboBox, Long Integer or String.
toComboBox
Long Integer
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.

ParameterTypeDescription
objComboBoxThe ComboBox whose index comes before the desired ComboBox.

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

ParameterTypeDescription
objComboBoxThe index of the ComboBox that follows the desired ComboBox.

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

Element of

Cell.comboBoxes

Character.comboBoxes

Document.comboBoxes

GraphicLine.comboBoxes

Group.comboBoxes

InsertionPoint.comboBoxes

Layer.comboBoxes

Line.comboBoxes

MasterSpread.comboBoxes

Oval.comboBoxes

Page.comboBoxes

Page.tabOrder

Paragraph.comboBoxes

PlaceGun.comboBoxes

Polygon.comboBoxes

Rectangle.comboBoxes

ShowHideFieldsBehavior.fieldsToHide

ShowHideFieldsBehavior.fieldsToShow

SplineItem.comboBoxes

Spread.comboBoxes

Story.comboBoxes

Table.comboBoxes

Text.comboBoxes

TextColumn.comboBoxes

TextFrame.comboBoxes

TextStyleRange.comboBoxes

Word.comboBoxes

XmlStory.comboBoxes

Jongware, 29-Apr-2012 v3.0.3iContents :: Index