Class

CheckBoxes

 A collection of checkboxes.

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

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

ParameterTypeDescription
indexnumberThe index.

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

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

CheckBox anyItem ()
Returns any CheckBox in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromCheckBox
Long Integer
String
The CheckBox, index, or name at the beginning of the range. Can accept: CheckBox, Long Integer or String.
toCheckBox
Long Integer
String
The CheckBox, index, or name at the end of the range. Can accept: CheckBox, Long Integer or String.

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

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

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

ParameterTypeDescription
objCheckBoxThe CheckBox whose index comes before the desired CheckBox.

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

ParameterTypeDescription
objCheckBoxThe index of the CheckBox that follows the desired CheckBox.

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

Element of

Cell.checkBoxes

Character.checkBoxes

Document.checkBoxes

GraphicLine.checkBoxes

Group.checkBoxes

InsertionPoint.checkBoxes

Layer.checkBoxes

Line.checkBoxes

MasterSpread.checkBoxes

Oval.checkBoxes

Page.checkBoxes

Page.tabOrder

Paragraph.checkBoxes

PlaceGun.checkBoxes

Polygon.checkBoxes

Rectangle.checkBoxes

ShowHideFieldsBehavior.fieldsToHide

ShowHideFieldsBehavior.fieldsToShow

Snippet.checkBoxes

SplineItem.checkBoxes

Spread.checkBoxes

Story.checkBoxes

Table.checkBoxes

Text.checkBoxes

TextColumn.checkBoxes

TextFrame.checkBoxes

TextStyleRange.checkBoxes

Word.checkBoxes

XmlStory.checkBoxes

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