Adobe InCopy CS5 (7.0) Object Model JS: CheckboxControls

InCopy CS5

Class

CheckboxControls

 A collection of checkbox controls.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

CheckboxControl add ([withProperties: Object])
Creates a new CheckboxControl.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new CheckboxControl (Optional)

CheckboxControl anyItem ()
Returns any CheckboxControl in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
fromCheckboxControl
Long Integer
String
The CheckboxControl, index, or name at the beginning of the range. Can accept: CheckboxControl, Long Integer or String.
toCheckboxControl
Long Integer
String
The CheckboxControl, index, or name at the end of the range. Can accept: CheckboxControl, Long Integer or String.

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

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

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

ParameterTypeDescription
objCheckboxControlThe CheckboxControl whose index comes before the desired CheckboxControl.

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

ParameterTypeDescription
objCheckboxControlThe index of the CheckboxControl that follows the desired CheckboxControl.

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

Element of

BorderPanel.checkboxControls

DialogColumn.checkboxControls

DialogRow.checkboxControls

EnablingGroup.checkboxControls

Jongware, 23-Mar-2011 v3.0.3dContents :: Index