Skip to content

# PDFVisualCheckBoxField

Namespace: O2S.Components.PDF4NET.View.Forms

Defines a checkbox field that is displayed in a PDFDocumentView control.

    public class PDFVisualCheckBoxField : PDFVisualField

Inheritance Object → PDFVisualField → PDFVisualCheckBoxField

## Constructors

### PDFVisualCheckBoxField(PDFCheckBoxField)

Initializes a new PDFVisualCheckBoxField object.

    public PDFVisualCheckBoxField(PDFCheckBoxField field)

Parameters

`field` PDFCheckBoxField
The underlying field object.

## Properties

### AlternateName

Gets or sets the field alternate name.

    public string AlternateName { get; set; }

Property Value

String
An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface.

### CalculateAction

Gets or sets the calculate action.

    public PDFJavaScriptAction CalculateAction { get; set; }

Property Value

PDFJavaScriptAction
A that shall be performed to recalculate the value of this field when that of another field changes.

### CheckBoxField

Gets the associated checkbox field.

    public PDFCheckBoxField CheckBoxField { get; }

Property Value

PDFCheckBoxField
The corresponding non-visual checkbox field.

### Checked

Gets or set a value indicating whether the CheckBox is in the checked state.

    public bool Checked { get; set; }

Property Value

Boolean
True if the CheckBox is in the checked state; otherwise, false.

### DefaultValue

Gets or sets the field default value.

    public object DefaultValue { get; set; }

Property Value

Object
The field's default value.

### Export

Gets or sets a value indicating whether the field can be exported or not.

    public bool Export { get; set; }

Property Value

Boolean
If true, the field shall be exported by a submit-form action.

### Field

Gets the underlying PDF field.

    public PDFField Field { get; internal set; }

Property Value

PDFField
The corresponding non-visual object.

### FormatAction

Gets or sets the format action.

    public PDFJavaScriptAction FormatAction { get; set; }

Property Value

PDFJavaScriptAction
A that shall be performed before the field is formatted to display its value.

### KeyPressAction

Gets or sets the keypress action.

    public PDFJavaScriptAction KeyPressAction { get; set; }

Property Value

PDFJavaScriptAction
A that shall be performed when the user modifies a character in a text field or combo box or modifies the selection in a scrollable list box.

### MappingName

Gets or sets the field mapping name.

    public string MappingName { get; set; }

Property Value

String
The mapping name that shall be used when exporting interactive form field data from the document.

### Name

Gets or sets the field name.

    public string Name { get; set; }

Property Value

String
The name of the field.

Exceptions

ArgumentException
Thrown when the name is not valid (null, empty, unsupported characters).

### ReadOnly

Gets or sets a value indicating whether the field is read-only.

    public bool ReadOnly { get; set; }

Property Value

Boolean
If true, the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions.

### Required

Gets or sets a value indicating whether the field is required.

    public bool Required { get; set; }

Property Value

Boolean
If true, the field shall have a value at the time it is exported by a submit-form action

### TextDirection

Gets or sets the text direction.

    public PDFTextDirection TextDirection { get; set; }

Property Value

PDFTextDirection
A enum member specifying the direction of the text displayed in the field.

### Type

Gets the field type.

    public PDFFieldType Type { get; }

Property Value

PDFFieldType
The field type.

### ValidateAction

Gets or sets the validate action.

    public PDFJavaScriptAction ValidateAction { get; set; }

Property Value

PDFJavaScriptAction
A that shall be performed when the field's value is changed. This action may check the new value for validity.

### Value

Gets or sets the field value.

    public object Value { get; set; }

Property Value

Object
The field value.

### VisualWidgets

Gets the collection of visual widgets for this field.

    public PDFVisualFieldWidgetCollection VisualWidgets { get; }

Property Value

PDFVisualFieldWidgetCollection
A collection of PDFVisualFieldWidget objects representing the field instances in a PDFDocumentView control.