# RadioButtonField

## Content

# Class: RadioButtonField

Represents group of radio buttons.

## Extends

- [`Field`](Field)

## Constructors

### Constructor

```ts
new RadioButtonField(om): RadioButtonField;
```

Creates a new RadioButtonField.

#### Parameters

##### om

[`ObjectManager`](ObjectManager)

[ObjectManager](ObjectManager) that controls the lifetime of the RadioButtonField.

#### Returns

`RadioButtonField`

#### Overrides

```ts
Field.constructor
```

### Constructor

```ts
new RadioButtonField(): RadioButtonField;
```

Creates a new RadioButtonField.

#### Returns

`RadioButtonField`

#### Overrides

```ts
Field.constructor
```

## Accessors

### alternateName

#### Get Signature

```ts
get alternateName(): string;
```

Gets or sets an alternate field name to be used in place of the actual field name wherever
the field must be identified in the user interface (such as in error or status messages referring to the field).
This text is also useful when extracting the document's contents in support of accessibility
to users with disabilities or for other purposes.

##### Returns

`string`

#### Set Signature

```ts
set alternateName(value): void;
```

Gets or sets an alternate field name to be used in place of the actual field name wherever
the field must be identified in the user interface (such as in error or status messages referring to the field).
This text is also useful when extracting the document's contents in support of accessibility
to users with disabilities or for other purposes.

##### Parameters

###### value

`string`

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`alternateName`](Field#alternatename)

***

### calculationIndex

#### Get Signature

```ts
get calculationIndex(): number;
```

Gets or sets an index that is used to determine the field's calculation order.
Fields with lower indices are calculated before fields with higher indices.

If several fields have the same CalculationIndex, the calculation order is determined
by the order of fields in the collection.

[recalculateValue](Field#recalculatevalue) can be used to specify JavaScript that is used to calculate the field's value.

##### Returns

`number`

#### Set Signature

```ts
set calculationIndex(value): void;
```

Gets or sets an index that is used to determine the field's calculation order.
Fields with lower indices are calculated before fields with higher indices.

If several fields have the same CalculationIndex, the calculation order is determined
by the order of fields in the collection.

[recalculateValue](Field#recalculatevalue) can be used to specify JavaScript that is used to calculate the field's value.

##### Parameters

###### value

`number`

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`calculationIndex`](Field#calculationindex)

***

### children

#### Get Signature

```ts
get children(): FieldCollection;
```

Gets the list of child fields.

##### Returns

[`FieldCollection`](FieldCollection)

#### Inherited from

[`Field`](Field).[`children`](Field#children)

***

### defaultValue

#### Get Signature

```ts
get defaultValue(): string | number | boolean | number[];
```

Gets or sets the field's default value.

##### Returns

`string` \| `number` \| `boolean` \| `number`[]

#### Set Signature

```ts
set defaultValue(value): void;
```

Gets or sets the field's default value.

##### Parameters

###### value

`string` \| `number` \| `boolean` \| `number`[]

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`defaultValue`](Field#defaultvalue)

***

### doc

#### Get Signature

```ts
get doc(): PdfDocument;
```

Gets the [PdfDocument](PdfDocument) owning this field.

##### Returns

[`PdfDocument`](PdfDocument)

#### Inherited from

[`Field`](Field).[`doc`](Field#doc)

***

### export

#### Get Signature

```ts
get export(): boolean;
```

Gets or sets a value indicating whether the field must not be exported by a [ActionSubmitForm](ActionSubmitForm) action.

##### Returns

`boolean`

#### Set Signature

```ts
set export(value): void;
```

Gets or sets a value indicating whether the field must not be exported by a [ActionSubmitForm](ActionSubmitForm) action.

##### Parameters

###### value

`boolean`

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`export`](Field#export)

***

### formatValue

#### Get Signature

```ts
get formatValue(): ActionJavaScript;
```

Gets or sets a JavaScript action to be performed before the field is formatted to display its current value.
This action can modify the field's value before formatting.

##### Returns

[`ActionJavaScript`](ActionJavaScript)

#### Set Signature

```ts
set formatValue(value): void;
```

Gets or sets a JavaScript action to be performed before the field is formatted to display its current value.
This action can modify the field's value before formatting.

##### Parameters

###### value

  \| [`ActionJavaScriptProperties`](../type-aliases/ActionJavaScriptProperties)
  \| [`ActionJavaScript`](ActionJavaScript)

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`formatValue`](Field#formatvalue)

***

### id

#### Get Signature

```ts
get id(): number;
```

Gets the reference to the object.

##### Returns

`number`

#### Inherited from

[`Field`](Field).[`id`](Field#id)

***

### justification

#### Get Signature

```ts
get justification(): VariableTextJustification;
```

Gets or sets the justification to be used in displaying the field's text.
Note that this field is used only if [WidgetAnnotation#justification](WidgetAnnotation#justification) is not specified.

##### Returns

[`VariableTextJustification`](../enumerations/VariableTextJustification)

#### Set Signature

```ts
set justification(value): void;
```

Gets or sets the justification to be used in displaying the field's text.
Note that this field is used only if [WidgetAnnotation#justification](WidgetAnnotation#justification) is not specified.

##### Parameters

###### value

[`VariableTextJustification`](../enumerations/VariableTextJustification)

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`justification`](Field#justification)

***

### keyPress

#### Get Signature

```ts
get keyPress(): ActionJavaScript;
```

Gets or sets a JavaScript action to be performed when the user types a keystroke into a
text field or combo box or modifies the selection in a scrollable list box.
This action can check the keystroke for validity and reject or modify it.

##### Returns

[`ActionJavaScript`](ActionJavaScript)

#### Set Signature

```ts
set keyPress(value): void;
```

Gets or sets a JavaScript action to be performed when the user types a keystroke into a
text field or combo box or modifies the selection in a scrollable list box.
This action can check the keystroke for validity and reject or modify it.

##### Parameters

###### value

  \| [`ActionJavaScriptProperties`](../type-aliases/ActionJavaScriptProperties)
  \| [`ActionJavaScript`](ActionJavaScript)

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`keyPress`](Field#keypress)

***

### mappingName

#### Get Signature

```ts
get mappingName(): string;
```

Gets or sets the mapping name to be used when exporting interactive form field data from the document.

##### Returns

`string`

#### Set Signature

```ts
set mappingName(value): void;
```

Gets or sets the mapping name to be used when exporting interactive form field data from the document.

##### Parameters

###### value

`string`

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`mappingName`](Field#mappingname)

***

### name

#### Get Signature

```ts
get name(): string;
```

Gets or sets the field's name.

##### Returns

`string`

#### Set Signature

```ts
set name(value): void;
```

Gets or sets the field's name.

##### Parameters

###### value

`string`

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`name`](Field#name)

***

### om

#### Get Signature

```ts
get om(): ObjectManager;
```

Gets the owner [ObjectManager](ObjectManager) instance.

##### Returns

[`ObjectManager`](ObjectManager)

#### Inherited from

[`Field`](Field).[`om`](Field#om)

***

### opt

#### Get Signature

```ts
get opt(): string[];
```

Gets or sets an array of strings containing one entry for each widget annotation,
defining export values for its constituent radio buttons.
See the PDF spec for details.

##### Returns

`string`[]

#### Set Signature

```ts
set opt(value): void;
```

Gets or sets an array of strings containing one entry for each widget annotation,
defining export values for its constituent radio buttons.
See the PDF spec for details.

##### Parameters

###### value

`string`[]

##### Returns

`void`

***

### owner

#### Get Signature

```ts
get owner(): FieldCollection;
```

Gets the [FieldCollection](FieldCollection) containing this field.

##### Returns

[`FieldCollection`](FieldCollection)

#### Inherited from

[`Field`](Field).[`owner`](Field#owner)

***

### parent

#### Get Signature

```ts
get parent(): Field;
```

Gets the parent field.

##### Returns

[`Field`](Field)

#### Inherited from

[`Field`](Field).[`parent`](Field#parent)

***

### radiosInUnison

#### Get Signature

```ts
get radiosInUnison(): boolean;
```

Gets or sets a value indicating whether a group of radio buttons within a radio button field
that use the same value for the on state will turn on and off in unison;
that is if one is checked, they are all checked.
If clear, the buttons are mutually exclusive (the same behavior as HTML radio buttons).

##### Returns

`boolean`

#### Set Signature

```ts
set radiosInUnison(value): void;
```

Gets or sets a value indicating whether a group of radio buttons within a radio button field
that use the same value for the on state will turn on and off in unison;
that is if one is checked, they are all checked.
If clear, the buttons are mutually exclusive (the same behavior as HTML radio buttons).

##### Parameters

###### value

`boolean`

##### Returns

`void`

***

### readOnly

#### Get Signature

```ts
get readOnly(): boolean;
```

Gets or sets a value indicating whether the user may not change the value of the field.
Any associated widget annotations will not interact with the user; that is,
they will not respond to mouse clicks or change their appearance in response to mouse motions.
This flag is useful for fields whose values are computed or imported from a database.

##### Returns

`boolean`

#### Set Signature

```ts
set readOnly(value): void;
```

Gets or sets a value indicating whether the user may not change the value of the field.
Any associated widget annotations will not interact with the user; that is,
they will not respond to mouse clicks or change their appearance in response to mouse motions.
This flag is useful for fields whose values are computed or imported from a database.

##### Parameters

###### value

`boolean`

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`readOnly`](Field#readonly)

***

### recalculateValue

#### Get Signature

```ts
get recalculateValue(): ActionJavaScript;
```

Gets or sets a JavaScript action to be performed to recalculate the value of this field when
that of another field changes.

##### Returns

[`ActionJavaScript`](ActionJavaScript)

#### Set Signature

```ts
set recalculateValue(value): void;
```

Gets or sets a JavaScript action to be performed to recalculate the value of this field when
that of another field changes.

##### Parameters

###### value

  \| [`ActionJavaScriptProperties`](../type-aliases/ActionJavaScriptProperties)
  \| [`ActionJavaScript`](ActionJavaScript)

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`recalculateValue`](Field#recalculatevalue)

***

### required

#### Get Signature

```ts
get required(): boolean;
```

Gets or sets a value indicating whether the field must have a value at the time it is
exported by a [ActionSubmitForm](ActionSubmitForm) action.

##### Returns

`boolean`

#### Set Signature

```ts
set required(value): void;
```

Gets or sets a value indicating whether the field must have a value at the time it is
exported by a [ActionSubmitForm](ActionSubmitForm) action.

##### Parameters

###### value

`boolean`

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`required`](Field#required)

***

### value

#### Get Signature

```ts
get value(): string | number | boolean | number[];
```

Gets or sets the field's value.

##### Returns

`string` \| `number` \| `boolean` \| `number`[]

#### Set Signature

```ts
set value(value): void;
```

Gets or sets the field's value.

##### Parameters

###### value

`string` \| `number` \| `boolean` \| `number`[]

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`value`](Field#value)

***

### valueChanged

#### Get Signature

```ts
get valueChanged(): ActionJavaScript;
```

Gets or sets a JavaScript action to be performed when the field's value is changed.
This action can check the new value for validity.

##### Returns

[`ActionJavaScript`](ActionJavaScript)

#### Set Signature

```ts
set valueChanged(value): void;
```

Gets or sets a JavaScript action to be performed when the field's value is changed.
This action can check the new value for validity.

##### Parameters

###### value

  \| [`ActionJavaScriptProperties`](../type-aliases/ActionJavaScriptProperties)
  \| [`ActionJavaScript`](ActionJavaScript)

##### Returns

`void`

#### Inherited from

[`Field`](Field).[`valueChanged`](Field#valuechanged)

***

### widgets

#### Get Signature

```ts
get widgets(): FieldWidgetCollection;
```

Gets the list of widget annotations associated with this field.

##### Returns

[`FieldWidgetCollection`](FieldWidgetCollection)

#### Inherited from

[`Field`](Field).[`widgets`](Field#widgets)

## Methods

### addItem()

```ts
addItem(
   page, 
   bounds, 
   checkStyle?, 
   borderStyle?): WidgetAnnotation;
```

Creates a new [WidgetAnnotation](WidgetAnnotation) and adds it to the [Field#widgets](Field#widgets) collection.

#### Parameters

##### page

[`PdfPage`](PdfPage)

The page on which the new [WidgetAnnotation](WidgetAnnotation) will be placed.

##### bounds

[`Rect`](../type-aliases/Rect)

The bounds of the new [WidgetAnnotation](WidgetAnnotation) on "page".

##### checkStyle?

[`CheckStyle`](../enumerations/CheckStyle)

The check mark style.

##### borderStyle?

[`BorderStyle`](../enumerations/BorderStyle)

The border style.

#### Returns

[`WidgetAnnotation`](WidgetAnnotation)

Returns the created [WidgetAnnotation](WidgetAnnotation) object.

***

### free()

```ts
free(): void;
```

Detaches the object from the [ObjectManager](ObjectManager) and deallocates its memory, if possible.

#### Returns

`void`

#### Inherited from

[`Field`](Field).[`free`](Field#free)

***

### getCheckedAppearanceStreamName()

```ts
getCheckedAppearanceStreamName(widgetIndex): string;
```

Gets the name of the checked appearance stream for the widget annotation
at the specified index.

#### Parameters

##### widgetIndex

`number`

The zero-based index of the widget annotation.

#### Returns

`string`

The appearance stream name, or null if not defined.

#### See

 - [getCheckedAppearanceStreamNames](#getcheckedappearancestreamnames)
 - [setCheckedAppearanceStreamName](#setcheckedappearancestreamname)

***

### getCheckedAppearanceStreamNames()

```ts
getCheckedAppearanceStreamNames(): string[];
```

Gets the names of the checked appearance streams for all widget annotations
associated with this RadioButtonField.

Each entry corresponds to a widget annotation (in the same order as [Field#widgets](Field#widgets))
and contains the name of the appearance stream used to display the widget's checked state.

#### Returns

`string`[]

An array of appearance stream names, or null if not defined.

#### See

 - [getCheckedAppearanceStreamName](#getcheckedappearancestreamname)
 - [setCheckedAppearanceStreamNames](#setcheckedappearancestreamnames)

***

### rebind()

```ts
rebind(omTo): void;
```

Rebinds the object from the current [ObjectManager](ObjectManager) to the specified one.

#### Parameters

##### omTo

[`ObjectManager`](ObjectManager)

The new [ObjectManager](ObjectManager) for the object.

#### Returns

`void`

#### Inherited from

[`Field`](Field).[`rebind`](Field#rebind)

***

### setCheckedAppearanceStreamName()

```ts
setCheckedAppearanceStreamName(widgetIndex, value): void;
```

Sets the name of the checked appearance stream for the widget annotation
at the specified index.

#### Parameters

##### widgetIndex

`number`

The zero-based index of the widget annotation.

##### value

`string`

The appearance stream name to assign.

#### Returns

`void`

#### See

 - [setCheckedAppearanceStreamNames](#setcheckedappearancestreamnames)
 - [getCheckedAppearanceStreamName](#getcheckedappearancestreamname)

***

### setCheckedAppearanceStreamNames()

```ts
setCheckedAppearanceStreamNames(value): void;
```

Sets the names of the checked appearance streams for all widget annotations
associated with this RadioButtonField.

Each entry corresponds to a widget annotation (in the same order as [Field#widgets](Field#widgets))
and specifies the name of the appearance stream used to display the widget's checked state.

#### Parameters

##### value

`string`

The appearance stream name to assign.

#### Returns

`void`

#### See

 - [getCheckedAppearanceStreamNames](#getcheckedappearancestreamnames)
 - [setCheckedAppearanceStreamName](#setcheckedappearancestreamname)