Class
CheckBoxField

Binary choice field that toggles on/off; supports custom export value and configurable appearance.

Definition

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

cs-api-definition

public class CheckBoxField : FormField<TwoStatesButtonWidget>, IStructuralElement

Initialize a new CheckBoxField with the provided name.

Declaration

cs-api-definition

public CheckBoxField(string fieldName)

Parameters

fieldName

The field name.

Gets or sets the value exported when the checkbox is checked; unchecked exports nothing by default.

Declaration

cs-api-definition

public string ExportValue { get; set; }

Property Value

Gets the field category reported to viewers for rendering and processing.

Declaration

cs-api-definition

public override sealed FormFieldType FieldType { get; }

Property Value

Gets or sets whether the checkbox is currently selected.

Declaration

cs-api-definition

public bool IsChecked { get; set; }

Property Value

Gets or sets whether the checkbox is selected when the form is reset to defaults.

Declaration

cs-api-definition

public bool IsCheckedByDefault { get; set; }

Property Value