Adobe InDesign CS6 (8.0) Object Model JS: CheckBox

InDesign CS6

previous page next page

Class

CheckBox

A checkbox. Base Class: FormField

QuickLinks

addEventListener, applyObjectStyle, asynchronousExportFile, autoTag, bringForward, bringToFront, changeObject, clearObjectStyleOverrides, clearTransformations, contentPlace, convertShape, convertToObject, detach, duplicate, exportFile, extractLabel, findObject, fit, flipItem, getElements, insertLabel, markup, move, override, placeXML, redefineScaling, reframe, remove, removeEventListener, removeOverride, resize, resolve, select, sendBackward, sendToBack, store, toSource, toSpecifier, transform, transformAgain, transformAgainIndividually, transformSequenceAgain, transformSequenceAgainIndividually, transformValuesOf

Hierarchy

FormField

CheckBox

Properties

Property	Type	Access	Description
absoluteFlip	Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH	r/w	Indicates whether the CheckBox has been flipped independently of its parent object and, if yes, the direction in which the CheckBox was flipped.
absoluteHorizontalScale	number	r/w	The horizontal scale of the CheckBox relative to its containing object.
absoluteRotationAngle	number	r/w	The rotation angle of the CheckBox relative to its containing object. (Range: -360 to 360)
absoluteShearAngle	number	r/w	The skewing angle of the CheckBox relative to its containing object. (Range: -360 to 360)
absoluteVerticalScale	number	r/w	The vertical scale of the CheckBox relative to its containing object.
activeStateIndex	number	r/w	The index of the active state in the object's states collection.
allArticles	Array of Article	readonly	The list of all articles this page item is part of
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the CheckBox.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the CheckBox.
allowOverrides	bool	r/w	If true, the master page item can be overridden.
anchoredObjectSettings	AnchoredObjectSetting	readonly	Anchored object settings.
animationSettings	AnimationSetting	readonly	The page item animation settings.
appliedObjectStyle	ObjectStyle	r/w	The object style applied to the CheckBox.
associatedXMLElement	XMLItem	readonly	The XML element associated with the CheckBox.
behaviors	Behaviors	readonly	A collection of behavior objects.
bottomLeftCornerOption	CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER	r/w	The shape to apply to the bottom left corner of rectangular shapes.
bottomLeftCornerRadius	Measurement Unit (Number or String)	r/w	The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
bottomRightCornerOption	CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER	r/w	The shape to apply to the bottom right corner of rectangular shapes.
bottomRightCornerRadius	Measurement Unit (Number or String)	r/w	The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
checkedByDefault	bool	r/w	If true, the check box/radio button is selected by default in the exported PDF.
clearFormBehaviors	ClearFormBehaviors	readonly	A collection of clear form behavior objects.
contentTransparencySettings	ContentTransparencySetting	readonly	Transparency settings for the content of the CheckBox.
description	string	r/w	The description of the CheckBox.
endCap	EndCap: EndCap.BUTT_END_CAP EndCap.ROUND_END_CAP EndCap.PROJECTING_END_CAP	r/w	The end shape of an open path.
endJoin	EndJoin: EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN EndJoin.BEVEL_END_JOIN	r/w	The corner join applied to the CheckBox.
epss	EPSs	readonly	A collection of EPS files.
epstexts	EPSTexts	readonly	EPSTexts
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
exportValue	string	r/w	Export value for the check box/radio button in the exported PDF.
fillColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the CheckBox. . Can also accept: String.
fillTint	number	r/w	The percent of tint to use in the CheckBox's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
fillTransparencySettings	FillTransparencySetting	readonly	Transparency settings for the fill applied to the CheckBox.
flip	Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH	r/w	The direction in which to flip the printed image.
gapColor	Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
gapTint	number	r/w	The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
geometricBounds	Array of Measurement Unit (Number or String)	r/w	The bounds of the CheckBox excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
gotoAnchorBehaviors	GotoAnchorBehaviors	readonly	A collection of goto anchor behavior objects.
gotoFirstPageBehaviors	GotoFirstPageBehaviors	readonly	A collection of goto first page behavior objects.
gotoLastPageBehaviors	GotoLastPageBehaviors	readonly	A collection of goto last page behavior objects.
gotoNextPageBehaviors	GotoNextPageBehaviors	readonly	A collection of goto next page behavior objects.
gotoNextViewBehaviors	GotoNextViewBehaviors	readonly	A collection of goto next view behavior objects.
gotoPreviousPageBehaviors	GotoPreviousPageBehaviors	readonly	A collection of goto previous page behavior objects.
gotoPreviousViewBehaviors	GotoPreviousViewBehaviors	readonly	A collection of goto previous view behavior objects.
gotoURLBehaviors	GotoURLBehaviors	readonly	A collection of goto URL behavior objects.
gradientFillAngle	number	r/w	The angle of a linear gradient applied to the fill of the CheckBox. (Range: -180 to 180)
gradientFillLength	Measurement Unit (Number or String)	r/w	The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the CheckBox.
gradientFillStart	Array of Measurement Unit (Number or String)	r/w	The starting point (in page coordinates) of a gradient applied to the fill of the CheckBox, in the format [x, y].
gradientStrokeAngle	number	r/w	The angle of a linear gradient applied to the stroke of the CheckBox. (Range: -180 to 180)
gradientStrokeLength	Measurement Unit (Number or String)	r/w	The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the CheckBox.
gradientStrokeStart	Array of Measurement Unit (Number or String)	r/w	The starting point (in page coordinates) of a gradient applied to the stroke of the CheckBox, in the format [x, y].
graphicLines	GraphicLines	readonly	A collection of graphic lines.
graphics	Graphics	readonly	A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
groups	Groups	readonly	A collection of groups.
hiddenUntilTriggered	bool	r/w	If true, the form field/push button is hidden until triggered in the exported PDF.
horizontalLayoutConstraints	Array of DimensionsConstraints: DimensionsConstraints.FIXED_DIMENSION DimensionsConstraints.FLEXIBLE_DIMENSION	r/w	The left margin, width, and right margin constraints this item is subject to when using the object-based layout rule.
horizontalScale	number	r/w	The horizontal scaling applied to the CheckBox.
id	number	readonly	The unique ID of the CheckBox.
images	Images	readonly	A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
index	number	readonly	The index of the CheckBox within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
itemLayer	Layer	r/w	The layer that the CheckBox is on.
label	string	r/w	A property that can be set to any string.
leftLineEnd	ArrowHead: ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD	r/w	The arrowhead applied to the start of the path.
linkedPageItemOptions	LinkedPageItemOption	readonly	Linked Page Item options
localDisplaySetting	DisplaySettingOptions: DisplaySettingOptions.HIGH_QUALITY DisplaySettingOptions.TYPICAL DisplaySettingOptions.OPTIMIZED DisplaySettingOptions.DEFAULT_VALUE	r/w	Display performance options for the CheckBox.
locked	bool	r/w	If true, the CheckBox is locked.
miterLimit	number (range: 1 - 500)	r/w	The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4)
movieBehaviors	MovieBehaviors	readonly	A collection of movie behavior objects.
name	string	r/w	The name of the CheckBox.
nonprinting	bool	r/w	If true, the CheckBox does not print.
openFileBehaviors	OpenFileBehaviors	readonly	A collection of open file behavior objects.
ovals	Ovals	readonly	A collection of ellipses.
overprintFill	bool	r/w	If true, the CheckBox's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGap	bool	r/w	If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStroke	bool	r/w	If true, the CheckBox's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
overridden	bool	readonly	If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
overriddenMasterPageItem	Graphic Guide Movie PageItem Sound	readonly	An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
pageItems	PageItems	readonly	The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
parent	Character GraphicLine Group MasterSpread Oval PlaceGun Polygon Rectangle Snippet SplineItem Spread	readonly	The parent of the CheckBox (a PlaceGun, Character, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group or Snippet).
parentPage	Page	readonly	The page on which this page item appears.
pdfs	PDFs	readonly	A collection of PDF files.
picts	PICTs	readonly	A collection of PICT graphics.
polygons	Polygons	readonly	A collection of polygons.
preferences	Preferences	readonly	A collection of preferences objects.
printFormBehaviors	PrintFormBehaviors	readonly	A collection of print form behavior objects.
printableInPdf	bool	r/w	If true, the form field/push button is printable in the exported PDF.
properties	Object	r/w	A property that allows setting of several properties at the same time.
readOnly	bool	r/w	If true, the form field is read only in the exported PDF.
rectangles	Rectangles	readonly	A collection of rectangles.
required	bool	r/w	If true, the form field is required in the exported PDF.
rightLineEnd	ArrowHead: ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD	r/w	The arrowhead applied to the end of the path.
rotationAngle	number	r/w	The rotatation angle of the CheckBox. (Range: -360 to 360)
shearAngle	number	r/w	The skewing angle applied to the CheckBox. (Range: -360 to 360)
showHideFieldsBehaviors	ShowHideFieldsBehaviors	readonly	A collection of show/hide fields behavior objects.
soundBehaviors	SoundBehaviors	readonly	A collection of sound behavior objects.
splineItems	SplineItems	readonly	The spline items collection.
states	States	readonly	A collection of states.
strokeAlignment	StrokeAlignment: StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT	r/w	The stroke alignment applied to the CheckBox.
strokeColor	String Swatch	r/w	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the CheckBox. Can also accept: String.
strokeCornerAdjustment	StrokeCornerAdjustment: StrokeCornerAdjustment.NONE StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.DASHES_AND_GAPS	r/w	The corner adjustment applied to the CheckBox.
strokeDashAndGap	Array of Measurement Unit (Number or String)	r/w	The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3].
strokeTint	number	r/w	The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
strokeTransparencySettings	StrokeTransparencySetting	readonly	Transparency settings for the stroke.
strokeType	String StrokeStyle	r/w	The name of the stroke style to apply. Can also accept: String.
strokeWeight	Measurement Unit (Number or String)	r/w	The weight (in points) to apply to the CheckBox's stroke.
submitFormBehaviors	SubmitFormBehaviors	readonly	A collection of submit form behavior objects.
textFrames	TextFrames	readonly	A collection of text frames.
textWrapPreferences	TextWrapPreference	readonly	The text wrap preference properties that define the default formatting for wrapping text around objects.
timingSettings	TimingSetting	readonly	The object timing settings.
topLeftCornerOption	CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER	r/w	The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.
topLeftCornerRadius	Measurement Unit (Number or String)	r/w	The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
topRightCornerOption	CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER	r/w	The shape to apply to the top right corner of rectangular shapes
topRightCornerRadius	Measurement Unit (Number or String)	r/w	The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
transparencySettings	TransparencySetting	readonly	Transparency settings.
verticalLayoutConstraints	Array of DimensionsConstraints: DimensionsConstraints.FIXED_DIMENSION DimensionsConstraints.FLEXIBLE_DIMENSION	r/w	The top margin, height, and bottom margin constraints this item is subject to when using the object-based layout rule.
verticalScale	number	r/w	The vertical scaling applied to the CheckBox.
viewZoomBehaviors	ViewZoomBehaviors	readonly	A collection of view zoom behavior objects.
visible	bool	r/w	If true, the CheckBox is visible.
visibleBounds	Array of Measurement Unit (Number or String)	r/w	The bounds of the CheckBox including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
wmfs	WMFs	readonly	A collection of WMF graphics.

Class

Property	Type	Access	Description
AFTER_PLACE	string	readonly	Dispatched after a CheckBox is placed. This event bubbles. This event is not cancelable. (default: afterPlace)
BEFORE_PLACE	string	readonly	Dispatched before a CheckBox is placed. This event bubbles. This event is cancelable. (default: beforePlace)

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
Applies the specified object style.

Parameter	Type	Description
using	ObjectStyle	The object style to apply.
clearingOverrides	bool	If true, clears the CheckBox's existing attributes before applying the style. (Optional) (default: true)
clearingOverridesThroughRootObjectStyle	bool	If true, clears attributes and formatting applied to the CheckBox that are not defined in the object style. (Optional) (default: false)

BackgroundTask asynchronousExportFile (format: varies, to: File[, showingOptions: bool=false][, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])
asynchronously exports the object(s) to a file.

Parameter	Type	Description
format	ExportFormat String	The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
to	File	The path to the export file.
showingOptions	bool	If true, displays the export options dialog. (Optional) (default: false)
using	PDFExportPreset	The export style. (Optional)
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false)

void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.

void bringForward ()
Brings the CheckBox forward one level in its layer.

void bringToFront ([reference: PageItem])
Brings the CheckBox to the front of its layer or in front of a particular item.

Parameter	Type	Description
reference	PageItem	The reference object to bring the object in front of (must have same parent) (Optional)

Array of PageItem changeObject ([reverseOrder: bool])
Finds objects that match the find what value and replace the objects with the change to value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

void clearObjectStyleOverrides ()
Clear overrides for object style

void clearTransformations ()
Clears transformations from the CheckBox. Transformations include rotation, scaling, flipping, fitting, and shearing.

Array of any contentPlace (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])
Duplicate an object and place it into the target page item.

Parameter	Type	Description
pageItems	Array of PageItem	One or more page items to place or load
linkPageItems	bool	Whether to link pageItems in content placer (if true it will override link stories value) (Optional) (default: false)
linkStories	bool	Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) (default: false)
mapStyles	bool	Whether to map styles in content placer (Optional) (default: false)
showingOptions	bool	Whether to display the link options dialog (Optional) (default: false)

void convertShape (given: ConvertShapeOptions[, numberOfSides: number][, insetPercentage: number][, cornerRadius: Measurement Unit (Number or String)])
Converts the CheckBox to a different shape.

Parameter	Type	Description
given	ConvertShapeOptions: ConvertShapeOptions.CONVERT_TO_RECTANGLE ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_OVAL ConvertShapeOptions.CONVERT_TO_TRIANGLE ConvertShapeOptions.CONVERT_TO_POLYGON ConvertShapeOptions.CONVERT_TO_LINE ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE ConvertShapeOptions.CONVERT_TO_OPEN_PATH ConvertShapeOptions.CONVERT_TO_CLOSED_PATH	The CheckBox's new shape.
numberOfSides	number (range: 3 - 100)	The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
insetPercentage	number (range: 0 - 100)	The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
cornerRadius	Measurement Unit (Number or String) (range: 0 - 800)	The corner radius of the resulting rectangle. (Optional)

void convertToObject ()
Converts the button object to the page item currently in the active state. Page items from other states will be lost.

void detach ()
Detaches an overridden master page item from the master page.

PageItem duplicate ([to: varies][, by: Array of Measurement Unit (Number or String)])
Duplicates the CheckBox at the specified location or offset.

Parameter	Type	Description
to	Array of 2 Units Layer Page Spread	The location of the new CheckBox, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by	Array of Measurement Unit (Number or String)	Amount by which to offset the new CheckBox from the original CheckBox's position. (Optional)

void exportFile (format: varies, to: File[, showingOptions: bool=false][, using: PDFExportPreset][, versionComments: string][, forceSave: bool=false])
Exports the object(s) to a file.

Parameter	Type	Description
format	ExportFormat String	The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
to	File	The path to the export file.
showingOptions	bool	If true, displays the export options dialog. (Optional) (default: false)
using	PDFExportPreset	The export style. (Optional)
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of PageItem findObject ([reverseOrder: bool])
Finds objects that match the find what value.

Parameter	Type	Description
reverseOrder	bool	If true, returns the results in reverse order. (Optional)

void fit (given: FitOptions)
Applies the specified fit option to content in a frame.

Parameter	Type	Description
given	FitOptions: FitOptions.CONTENT_TO_FRAME FitOptions.CENTER_CONTENT FitOptions.PROPORTIONALLY FitOptions.FRAME_TO_CONTENT FitOptions.FILL_PROPORTIONALLY FitOptions.APPLY_FRAME_FITTING_OPTIONS	The fit option to use.

void flipItem (given: Flip[, around: varies])
Flips the CheckBox.

Parameter	Type	Description
given	Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH	The axis around which to flip the CheckBox.
around	AnchorPoint Array of 2 Units	The point around which to flip the CheckBox. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

Array of CheckBox getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void markup (using: XMLElement)
Associates the page item with the specified XML element while preserving existing content.

Parameter	Type	Description
using	XMLElement	The XML element.

void move ([to: varies][, by: Array of Measurement Unit (Number or String)])
Moves the CheckBox to a new location. Note: Either the 'to' or 'by' parameter is required; if both parameters are defined, only the to value is used.

Parameter	Type	Description
to	Array of 2 Units Layer Page Spread	The new location of the CheckBox,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by	Array of Measurement Unit (Number or String)	The amount (in measurement units) to move the CheckBox relative to its current position, in the format (x, y). (Optional)

any override (destinationPage: Page)
Overrides a master page item and places the item on the document page as a new object.

Parameter	Type	Description
destinationPage	Page	The document page that contains the master page item to override.

void placeXML (using: XMLElement)
Places XML content into the specified object. Note: Replaces any existing content.

Parameter	Type	Description
using	XMLElement	The XML element whose content you want to place.

void redefineScaling ([to: Array of number])
Apply an item's scaling to its content if possible.

Parameter	Type	Description
to	Array of number	The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

void reframe (in: varies, opposingCorners: Array of varies)
Move the bounding box of the page item

Parameter	Type	Description
in	boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace:CoordinateSpaces	The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
opposingCorners	Array of any	Opposing corners of new bounding box in the given coordinate space

void remove ()
Deletes the CheckBox.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void removeOverride ()
Removes the override from a previously overridden master page item.

void resize (in: varies, from: varies, by: ResizeMethods, values: Array of varies[, resizeIndividually: bool=true][, consideringRulerUnits: bool=false])
Resize the page item.

Parameter	Type	Description
in	BoundingBoxLimits boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace:CoordinateSpaces	The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
from	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	The transform origin. Legal specifications: relative to bounding box: anchor \| {anchor \| {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} \| {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index \| bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
by	ResizeMethods: ResizeMethods.ADDING_CURRENT_DIMENSIONS_TO ResizeMethods.MULTIPLYING_CURRENT_DIMENSIONS_BY ResizeMethods.REPLACING_CURRENT_DIMENSIONS_WITH ResizeMethods.RESHAPING_AREA_TO_RATIO ResizeMethods.RESHAPING_BORDER_TO_RATIO	How the current dimensions are affected by the given values
values	Array of : Array of Reals CoordinateSpaces ResizeConstraints	The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators.
resizeIndividually	bool	If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) (default: true)
consideringRulerUnits	bool	If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false)

any resolve (location: varies, in: CoordinateSpaces[, consideringRulerUnits: bool=false])
Get the coordinates of the given location in the specified coordinate system.

Parameter	Type	Description
location	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
in	CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PAGE_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use.
consideringRulerUnits	bool	If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false)

void select ([existingSelection: SelectionOptions=SelectionOptions.REPLACE_WITH])
Selects the object.

Parameter	Type	Description
existingSelection	SelectionOptions: SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH SelectionOptions.SET_KEY	The selection status of the CheckBox in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

void sendBackward ()
Sends the CheckBox back one level in its layer.

void sendToBack ([reference: PageItem])
Sends the CheckBox to the back of its layer or behind a particular item (must have same parent).

Parameter	Type	Description
reference	PageItem	The reference object to send the object behind (Optional)

Asset store (using: Library[, withProperties: Object])
Stores the object in the specified library.

Parameter	Type	Description
using	Library	The library in which to store the object.
withProperties	Object	Initial values for properties of the new CheckBox (Optional)

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

string toSpecifier ()
Retrieves the object specifier.

void transform (in: CoordinateSpaces, from: varies, withMatrix: varies[, replacingCurrent: varies][, consideringRulerUnits: bool=false])
Transform the page item.

Parameter	Type	Description
in	CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PAGE_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use
from	AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers	The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
withMatrix	Array of 6 Reals TransformationMatrix	Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrent	Array of MatrixContent Long Integer MatrixContent	Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)
consideringRulerUnits	bool	If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false)

Array of string transformAgain ()
Transforms the CheckBox using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformAgainIndividually ()
Transforms the CheckBox using the last transformation performed on any CheckBox. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformSequenceAgain ()
Transforms the CheckBox using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of string transformSequenceAgainIndividually ()
Transforms the CheckBox using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

Array of TransformationMatrix transformValuesOf (in: CoordinateSpaces)
Get the transformation values of the page item.

Parameter	Type	Description
in	CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PAGE_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use