Skip to content

# PDFVisualCheckBoxWidget

Namespace: O2S.Components.PDF4NET.View.Forms

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

    public class PDFVisualCheckBoxWidget : PDFVisualCheckWidget

Inheritance Object → PDFVisualAnnotation → PDFVisualFieldWidget → PDFVisualCheckWidget → PDFVisualCheckBoxWidget

## Constructors

### PDFVisualCheckBoxWidget(PDFCheckBoxWidget)

Initializes a new PDFVisualCheckBoxWidget object.

    public PDFVisualCheckBoxWidget(PDFCheckBoxWidget fieldWidget)

Parameters

`fieldWidget` PDFCheckBoxWidget
The underlying field widget.

## Properties

### Annotation

Gets the underlying PDF annotation.

    public PDFAnnotation Annotation { get; }

Property Value

PDFAnnotation
A PDF annotation.

### BackgroundColor

Gets or sets the widget background color.

    public PDFColor BackgroundColor { get; set; }

Property Value

PDFColor
A specifying the widget's background color.

Exceptions

ArgumentOutOfRangeException
Thrown when the property is set to a color other than Gray, RGB or CMYK.

### BorderColor

Gets or sets the widget border color.

    public PDFColor BorderColor { get; set; }

Property Value

PDFColor
A specifying the widget's border color.

Exceptions

ArgumentOutOfRangeException
Thrown when the property is set to a color other than Gray, RGB or CMYK.

### BorderDashPattern

Gets or sets the array that represents the dash pattern when the PDFVisualFieldWidget.BorderStyle property is set to .

    public Double[] BorderDashPattern { get; set; }

Property Value

Double[]
An array of double values specifying the style of the dashed line.

### BorderStyle

Gets or sets the widget border style.

    public PDFAnnotationBorderStyle BorderStyle { get; set; }

Property Value

PDFAnnotationBorderStyle
A enum specifying the style of the widget border.

### BorderWidth

Gets or sets the widget border width.

    public double BorderWidth { get; set; }

Property Value

Double
A specifying the widget's border width.

### CheckBoxWidget

Gets the underlying checkbox widget.

    public PDFCheckBoxWidget CheckBoxWidget { get; }

Property Value

PDFCheckBoxWidget
A object representing the non-visual checkbox widget.

### Checked

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

    public bool Checked { get; set; }

Property Value

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

### CheckedStateNormalAppearance

Gets or sets the normal visual appearance for the widget in checked state.

    public PDFAnnotationAppearance CheckedStateNormalAppearance { get; set; }

Property Value

PDFAnnotationAppearance
The normal visual appearance of the widget in checked state.

Remarks

The visual appearance of the widget in checked state when the user does not interact with the widget.

### CheckStyle

Gets or sets the style of the checked widget.

    public PDFCheckStyle CheckStyle { get; set; }

Property Value

PDFCheckStyle
A that represents the style of the checked widget.

### DisplayRectangle

Gets or sets the visual rectangle of this annotation.

    public PDFDisplayRectangle DisplayRectangle { get; set; }

Property Value

PDFDisplayRectangle
A that represents the position and size of the annotation on the page.

Remarks

The visual rectangle is relative to the top left corner of the page.

### ExportValue

Gets or sets the widget's export value.

    public string ExportValue { get; set; }

Property Value

String
The symbolic value associated with the check widget.

Remarks

When the form data is exported as FDF/XFDF/HTML or XML and the check widget is checked then this value is written to exported data stream.

### NormalAppearance

Gets or sets the annotation normal appearance.

    public PDFAnnotationAppearance NormalAppearance { get; set; }

Property Value

PDFAnnotationAppearance
A specifying how the annotation is presented visually on the page.

### Tag

Gets or sets an object that contains user-defined data associated with the annotation.

    public object Tag { get; set; }

Property Value

Object

Remarks

This property can be used to store any custom information relevant to the annotation at runtime. The value is not used by the annotation itself and is intended solely for application-specific data.
NOTE: The value of this property is not persisted in the PDF file.

### UncheckedStateNormalAppearance

Gets or sets the normal visual appearance for the widget in unchecked state.

    public PDFAnnotationAppearance UncheckedStateNormalAppearance { get; set; }

Property Value

PDFAnnotationAppearance
The normal visual appearance of the widget in unchecked state.

Remarks

The visual appearance of the widget in unchecked state when the user does not interact with the widget.

### VisualField

Gets the visual field that owns this widget.

    public PDFVisualField VisualField { get; internal set; }

Property Value

PDFVisualField
A PDFVisualField descendant that represents a field in the PDF document.

### VisualPage

Gets the page that owns the anotation.

    public PDFVisualPage VisualPage { get; internal set; }

Property Value

PDFVisualPage
The PDFVisualPage that owns the annotation.

### Widget

Gets the underlying field widget.

    public PDFFieldWidget Widget { get; }

Property Value

PDFFieldWidget
A object representing the non-visual field widget.