Adobe InCopy CS6 (8.0) Object Model JS: RadioButtons

InCopy CS6

Class

RadioButtons

 A collection of radio buttons.

See also RadioButton.

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

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

ParameterTypeDescription
indexnumberThe index.

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

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

RadioButton anyItem ()
Returns any RadioButton in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromLong Integer
RadioButton
String
The RadioButton, index, or name at the beginning of the range. Can accept: RadioButton, Long Integer or String.
toLong Integer
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.

ParameterTypeDescription
objRadioButtonThe RadioButton whose index comes before the desired RadioButton.

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

ParameterTypeDescription
objRadioButtonThe index of the RadioButton that follows the desired RadioButton.

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

Element of

Cell.radioButtons

Character.radioButtons

Document.radioButtons

GraphicLine.radioButtons

Group.radioButtons

InsertionPoint.radioButtons

Layer.radioButtons

Line.radioButtons

MasterSpread.radioButtons

Oval.radioButtons

Page.radioButtons

Page.tabOrder

Paragraph.radioButtons

PlaceGun.radioButtons

Polygon.radioButtons

Rectangle.radioButtons

ShowHideFieldsBehavior.fieldsToHide

ShowHideFieldsBehavior.fieldsToShow

SplineItem.radioButtons

Spread.radioButtons

Story.radioButtons

Table.radioButtons

Text.radioButtons

TextColumn.radioButtons

TextFrame.radioButtons

TextStyleRange.radioButtons

Word.radioButtons

XmlStory.radioButtons

Jongware, 29-Apr-2012 v3.0.3iContents :: Index