Class

# PDFRadioButton

<div class="rst-class">

forsearch

</div>

PDF

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

## Description

A radio button that can be embedded into a `PDFDocument</api/pdf/pdfdocument>`.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                | Type                                                                                      | Read-Only | Shared |
|-------------------------------------|-------------------------------------------------------------------------------------------|-----------|--------|
| `Action<pdfradiobutton.action>`     | `PDFButton.Actions<pdfbutton.actions>` = `PDFButton.Actions.ResetForm<pdfbutton.actions>` |           |        |
| `Caption<pdfradiobutton.caption>`   | `String</api/data_types/string>`                                                          |           |        |
| `FontSize<pdfradiobutton.fontsize>` | `Integer</api/data_types/integer>`                                                        |           |        |
| `Height<pdfradiobutton.height>`     | `Integer</api/data_types/integer>`                                                        |           |        |
| `Name<pdfradiobutton.name>`         | `String</api/data_types/string>`                                                          |           |        |
| `Name<pdfradiobutton.name>`         | `String</api/data_types/string>`                                                          |           |        |
| `Page<pdfradiobutton.page>`         | `Integer</api/data_types/integer>`                                                        | ✓         |        |
| `URL<pdfradiobutton.url>`           | `String</api/data_types/string>`                                                          |           |        |
| `Value<pdfradiobutton.value>`       | `Boolean</api/data_types/boolean>`                                                        |           |        |
| `Width<pdfradiobutton.width>`       | `Integer</api/data_types/integer>`                                                        |           |        |
| `X<pdfradiobutton.x>`               | `Integer</api/data_types/integer>`                                                        |           |        |
| `Y<pdfradiobutton.y>`               | `Integer</api/data_types/integer>`                                                        |           |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                       | Parameters                                                                                                                                                                                                                                                                                                       | Returns | Shared |
|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|--------|
| `Constructor<pdfradiobutton.constructor0>` | pageNumber As `Integer</api/data_types/integer>`, x As `Integer</api/data_types/integer>`, y As `Integer</api/data_types/integer>`, width As `Integer</api/data_types/integer>`, height As `Integer</api/data_types/integer>`, name As `String</api/data_types/string>`, tag As `String</api/data_types/string>` |         |        |
| `Constructor<pdfradiobutton.constructor1>` | pageNumber As `Integer</api/data_types/integer>`, x As `Integer</api/data_types/integer>`, y As `Integer</api/data_types/integer>`, width As `Integer</api/data_types/integer>`, height As `Integer</api/data_types/integer>`                                                                                    |         |        |

## Property descriptions

<div id="pdfradiobutton.action">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.Action

**Action** As `PDFButton.Actions<pdfbutton.actions>` = `PDFButton.Actions.ResetForm<pdfbutton.actions>`

> The action the button will take when pressed.

<div id="pdfradiobutton.caption">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.Caption

**Caption** As `String</api/data_types/string>`

> The text of the button.

<div id="pdfradiobutton.fontsize">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.FontSize

**FontSize** As `Integer</api/data_types/integer>`

> The size of the text of the control.

<div id="pdfradiobutton.height">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.Height

**Height** As `Integer</api/data_types/integer>`

> The height of the control.

<div id="pdfradiobutton.name">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.Name

**Name** As `String</api/data_types/string>`

> The name of the control.
>
> In order for two or more <span class="title-ref">PDFRadioButton</span>'s to act as a group, all must share the same Name property value.

<div id="pdfradiobutton.page">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.Page

**Page** As `Integer</api/data_types/integer>`

> The number of the page upon which the control was created.
>
> This property is read-only.

<div id="pdfradiobutton.url">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.URL

**URL** As `String</api/data_types/string>`

> The URL to which the values of controls will be submitted.

<div id="pdfradiobutton.value">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.Value

**Value** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, the radio button is selected.

<div id="pdfradiobutton.width">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.Width

**Width** As `Integer</api/data_types/integer>`

> The width of the control.

<div id="pdfradiobutton.x">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.X

**X** As `Integer</api/data_types/integer>`

> The location on the X axis of the upper-left corner of the control.

<div id="pdfradiobutton.y">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.Y

**Y** As `Integer</api/data_types/integer>`

> The location on the Y axis of the upper-left corner of the control.

## Method descriptions

<div id="pdfradiobutton.constructor0">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.Constructor

**Constructor**(pageNumber As `Integer</api/data_types/integer>`, x As `Integer</api/data_types/integer>`, y As `Integer</api/data_types/integer>`, width as `Integer</api/data_types/integer>`, height As `Integer</api/data_types/integer>`, name As `String</api/data_types/string>`, tag As `String</api/data_types/string>`)

> <div class="note">
>
> <div class="title">
>
> Note
>
> </div>
>
> `Constructors</api/language/constructor>` are special methods called when you create an object with the `New</api/language/new>` keyword and pass in the parameters above.
>
> </div>
>
> Returns a new <span class="title-ref">PDFRadioButton</span> based upon the values passed.

<div id="pdfradiobutton.constructor1">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFRadioButton.Constructor

**Constructor**(pageNumber As `Integer</api/data_types/integer>`, x As `Integer</api/data_types/integer>`, y As `Integer</api/data_types/integer>`, width As `Integer</api/data_types/integer>`, height As `Integer</api/data_types/integer>`)

> Creates an instance of the button with the values passed.

## Notes

In order for two or more <span class="title-ref">PDFRadioButton</span>'s to act as a group, all must share the same Name property value.

Only the button itself is drawn. If you want a label for the button, you'll need to draw that yourself.

## Compatibility

|                       |                               |
|-----------------------|-------------------------------|
| **Project Types**     | Console, Desktop, Mobile, Web |
| **Operating Systems** | iOS, Linux, macOS, Windows    |

<div class="seealso">

`PDFButton</api/pdf/pdfbutton>` parent class; `PDFDocument.AddControl<pdfdocument.addcontrol>` method.

</div>