Class
RadioButtonField

Radio button group enabling a single logical choice (or controlled deselection) among mutually exclusive options in a PDF form.

Definition

Namespace:Telerik.Windows.Documents.Fixed.Model.InteractiveForms

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

cs-api-definition
public sealed class RadioButtonField : FormField, IStructuralElement

Inheritance: objectFormFieldRadioButtonField

Implements: IStructuralElement

Inherited Members FormField.Equals(object)FormField.GetHashCode()FormField.NameFormField.TextPropertiesFormField.ActionsFormField.UserInterfaceNameFormField.MappingNameFormField.IsReadOnlyFormField.IsRequiredFormField.ShouldBeSkippedFormField.StructureTag

Constructors

RadioButtonField(string)

Create a radio button field grouping options under the specified fieldName.

Declaration

cs-api-definition
public RadioButtonField(string fieldName)

Parameters

fieldName

string

The field name.

Properties

AllowToggleOff

Gets or sets whether the user may toggle the selected option off leaving the group with no selection.

Declaration

cs-api-definition
public bool AllowToggleOff { get; set; }

Property Value

bool

DefaultValue

Gets or sets the option selected after a form reset (default choice).

Declaration

cs-api-definition
public RadioOption DefaultValue { get; set; }

Property Value

RadioOption

FieldType

Gets the form field type identifier (RadioButton) used during export and processing.

Declaration

cs-api-definition
public override FormFieldType FieldType { get; }

Property Value

FormFieldType

Overrides FormField.FieldType

Options

Gets the list of mutually exclusive selectable options.

Declaration

cs-api-definition
public RadioOptionCollection Options { get; }

Property Value

RadioOptionCollection

A collection containing all radio button options that users can choose from.

ShouldUpdateRadiosInUnison

Gets or sets whether widgets sharing an identical value update selection state together (value‑based unison behavior).

Declaration

cs-api-definition
public bool ShouldUpdateRadiosInUnison { get; set; }

Property Value

bool

Value

Gets or sets the currently selected option; changing it raises the value changed event.

Declaration

cs-api-definition
public RadioOption Value { get; set; }

Property Value

RadioOption

The selected radio option, or null if no option is currently selected.

Widgets

Gets the widget collection rendering each option on document pages.

Declaration

cs-api-definition
public RadioButtonWidgetCollection Widgets { get; }

Property Value

RadioButtonWidgetCollection

A specialized widget collection containing all radio button widgets associated with this field.