CheckBoxes

A collection of checkboxes.

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
length	Number	readonly	The number of objects in the collection.

Method Listing

CheckBox [] (index:Number)

Returns the CheckBox with the specified index.

Parameter	Type	Description
index	Number	The index.

CheckBox add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document Layer MasterSpread Page Spread PageItem, withProperties:Object)

Creates a new CheckBox

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

CheckBox everyItem ()

Returns every CheckBox in the collection.

CheckBox firstItem ()

Returns the first CheckBox in the collection.

CheckBox item (index:Varies LongInteger String)

Returns the CheckBox with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

CheckBox itemByID (id:Number)

Returns the CheckBox with the specified ID.

Parameter	Type	Description
id	Number	The ID.

CheckBox itemByName (name:String)

Returns the CheckBox with the specified name.

Parameter	Type	Description
name	String	The name.

CheckBox itemByRange (from:Varies CheckBox LongInteger String, to:Varies CheckBox LongInteger String)

Returns the CheckBoxes within the specified range.

Parameter	Type	Description
from	CheckBox LongInteger String	The CheckBox, index, or name at the beginning of the range. Can accept: CheckBox, Long Integer or String.
to	CheckBox LongInteger String	The CheckBox, index, or name at the end of the range. Can accept: CheckBox, Long Integer or String.

Parameter

Type

Description

from

CheckBox

LongInteger

String

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

CheckBox

LongInteger

String

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