Class RadioButtonFormField
A group of radio buttons. Similar to CheckBoxFormField but there can only be one value set at the same time.
Inheritance
Implements
Namespace: PSPDFKit.Pdf.Form
Assembly: PSPDFKit.dll
Syntax
public sealed class RadioButtonFormField : IFormFieldProperties
AnnotationIDs
A list of Id.
Declaration
public IList<string> AnnotationIDs { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
DefaultValue
Similar to the Value property. The default values are only used when a form needs to be reset.
Declaration
public string DefaultValue { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Label
Used to identify the form field in the UI or for accessibility.
Declaration
public string Label { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Name
Unique name of the form field (often referred to as fully qualified name). This name is used to link Widget annotations and is also used as an identifier for form field values.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
NoExport
Determines if the form field will appear in the serialized payload of a form submission. Defaults to false.
Declaration
public bool NoExport { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
NoToggleToOff
If true, exactly one radio button must be selected at all times. Clicking the currently selected button has no effect. Otherwise, clicking the selected button deselects it, leaving no button selected. Default value is false.
Declaration
public bool NoToggleToOff { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Options
A list of FormOptions. This is necessary to map the multiple radio button options to their values.
Declaration
public IList<FormOption> Options { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<FormOption> |
PdfObjectId
The object ID of the form field object in the PDF.
Declaration
public int PdfObjectId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
RadiosInUnison
If true, 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: If one is checked, they are all checked (the same behavior as HTML radio buttons). Otherwise, only the checked radio button will be marked checked.
Declaration
public bool RadiosInUnison { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
ReadOnly
Read only form fields can not be filled out. Defaults to false.
Declaration
public bool ReadOnly { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Required
Required form fields must be filled out in order to submit the form. Defaults to false.
Declaration
public bool Required { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Value
The selected form option value.
Declaration
public string Value { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |