Class ToggleButtonField

An on/off toggle button field (spec §12.7.4.2). A toggle button is a button field that toggles between two states — on and off — without belonging to a mutually exclusive radio group. Unlike a check box, the toggle button uses a ButtonAppearance model that supports per-trigger label and icon content.

Inheritance

object

FormField

ToggleButtonField

Inherited Members

FormField.Name

FormField.Tooltip

FormField.IsRequired

FormField.Page

FormField.Rect

FormField.Appearance

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: DRIT.Pdf.Forms

Assembly: DRIT.Pdf.dll

Syntax

public sealed class ToggleButtonField : FormField

Properties

ButtonAppearance

The button appearance model supporting per-trigger label and icon content.

Declaration

public ButtonAppearance ButtonAppearance { get; }

Property Value

Type	Description
ButtonAppearance

ExportValue

The export value written to the /V and /AS entries when the button is on. Defaults to "Yes".

Declaration

public string ExportValue { get; set; }

Property Value

Type	Description
string

FieldType

The field type.

Declaration

public override FieldType FieldType { get; }

Property Value

Type	Description
FieldType

Overrides

FormField.FieldType

IsChecked

Whether the toggle is currently in the on state.

Declaration

public bool IsChecked { get; set; }

Property Value

Type	Description
bool

Value

The current value of the field (type depends on field kind).

Declaration

public override object? Value { get; set; }

Property Value

Type	Description
object

Overrides

FormField.Value