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.11.0+eb7160cc6b920e36fb1ea2abe5f76809067c0c55

Syntax

Copy

public class CheckBox : Field

The CheckBox type exposes the following members.

Properties

	Name	Description
	Checked	The state of the check box
	CheckedExportName	The name of the checked ('on') state used when exporting
	DisplayName	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)
	DoNotExport	Tells whether this field is exported (Inherited from Field)
	ExportName	The name used when exporting (Inherited from FieldNode)
	ReadOnly	Flags this field as read-only (Inherited from Field)
	Required	Flags this field as mandatory (Inherited from Field)
	Widgets	This form field's widget annotations (Inherited from Field)

Top

Methods

	Name	Description
	AddNewWidget	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)
	Create	Create a check box form field The returned form field object is not yet used, but it is associated with the given target document.
	Equals	(Inherited from NativeObject)
	GetHashCode	(Inherited from NativeObject)

Top

Reference

PdfTools.Toolbox.Pdf.Forms Namespace