Click or drag to resize
Pdftools logo

CheckBox Class

A check box field

Inheritance Hierarchy
SystemObject
  PdfTools.Toolbox.InternalNativeBase
    PdfTools.Toolbox.InternalNativeObject
      PdfTools.Toolbox.Pdf.FormsFieldNode
        PdfTools.Toolbox.Pdf.FormsField
          PdfTools.Toolbox.Pdf.FormsCheckBox

Namespace: PdfTools.Toolbox.Pdf.Forms
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.0.0+fdabb036503e9f99735634a6d4f5be875399e9f5
Syntax
C#
public class CheckBox : Field

The CheckBox type exposes the following members.

Properties
 NameDescription
Public propertyChecked

The state of the check box

Public propertyCheckedExportName

The name of the checked ('on') state used when exporting

Public propertyDisplayName

User interface name

The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.
(Inherited from FieldNode)
Public propertyDoNotExport

Tells whether this field is exported


(Inherited from Field)
Public propertyExportName

The name used when exporting


(Inherited from FieldNode)
Public propertyReadOnly

Flags this field as read-only


(Inherited from Field)
Public propertyRequired

Flags this field as mandatory


(Inherited from Field)
Public propertyWidgets

This form field's widget annotations


(Inherited from Field)
Top
Methods
 NameDescription
Public methodAddNewWidget

Create a new widget and add to the form field

This method creates a widget for the form field. The widget is automatically added to the field's widgets, but not to any page. This method does not work for radio button form fields; Use AddNewWidget(Rectangle).
(Inherited from Field)
Public methodStatic memberCreate

Create a check box form field

The returned form field object is not yet used, but it is associated with the given target document.
Public methodEquals
(Inherited from NativeObject)
Public methodGetHashCode
(Inherited from NativeObject)
Top
See Also