RadioButtons

A collection of radio buttons.

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

RadioButton [] (index:Number)

Returns the RadioButton with the specified index.

Parameter

Type

Description

index

Number

The index.

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

Creates a new RadioButton

Parameter

Type

Description

layer

Layer

The layer on which to create the RadioButton. (Optional)

at

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location at which to insert the RadioButton 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 RadioButton (Optional)

RadioButton anyItem ()

Returns any RadioButton in the collection.

Number count ()

Displays the number of elements in the RadioButton.

RadioButton everyItem ()

Returns every RadioButton in the collection.

RadioButton firstItem ()

Returns the first RadioButton in the collection.

RadioButton item (index:Varies LongInteger String)

Returns the RadioButton with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

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

RadioButton itemByID (id:Number)

Returns the RadioButton with the specified ID.

Parameter

Type

Description

id

Number

The ID.

RadioButton itemByName (name:String)

Returns the RadioButton with the specified name.

Parameter

Type

Description

name

String

The name.

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

Returns the RadioButtons within the specified range.

Parameter

Type

Description

from

LongInteger

RadioButton

String

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

to

LongInteger

RadioButton

String

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

RadioButton lastItem ()

Returns the last RadioButton in the collection.

RadioButton middleItem ()

Returns the middle RadioButton in the collection.

RadioButton nextItem (obj:RadioButton)

Returns the RadioButton whose index follows the specified RadioButton in the collection.

Parameter

Type

Description

obj

RadioButton

The RadioButton whose index comes before the desired RadioButton.

RadioButton previousItem (obj:RadioButton)

Returns the RadioButton with the index previous to the specified index.

Parameter

Type

Description

obj

RadioButton

The index of the RadioButton that follows the desired RadioButton.

String toSource ()

Generates a string which, if executed, will return the RadioButton.

Object of

PlaceGun.radioButtons

Document.radioButtons

Layer.radioButtons

Spread.radioButtons

Page.radioButtons

MasterSpread.radioButtons

Oval.radioButtons

Rectangle.radioButtons

GraphicLine.radioButtons

Polygon.radioButtons

Group.radioButtons

SplineItem.radioButtons

Snippet.radioButtons

Cell.radioButtons

Table.radioButtons

Text.radioButtons

Character.radioButtons

Word.radioButtons

Line.radioButtons

TextColumn.radioButtons

Paragraph.radioButtons

TextStyleRange.radioButtons

InsertionPoint.radioButtons

TextFrame.radioButtons

Story.radioButtons

EndnoteTextFrame.radioButtons

XmlStory.radioButtons

ShowHideFieldsBehavior.fieldsToHide

Page.tabOrder

ShowHideFieldsBehavior.fieldsToShow