CheckBoxField Class

A checkbox form field that allows users to select or clear an option in a PDF document.

Namespace: DevExpress.Docs.Pdf

Assembly: DevExpress.Docs.Pdf.v26.1.dll

Declaration

C#

public class CheckBoxField :
    FormField

VB.NET

Public Class CheckBoxField
    Inherits FormField

Remarks

For more information, refer to the following help topic: DevExpress PDF Document API - Form Fields.

Example

How to: Add a Check Box Field to a PDF Document

The following code snippet adds a checkbox field to a PDF document and binds it to a checkbox widget:

C#

using DevExpress.Docs.Pdf;
using DevExpress.Drawing.Printing;
using System.Drawing;

namespace ConsoleApp1;

public class Program {
    public static async Task Main(string[] _) {
        using (PdfDocument pdfDocument = new()) {
            // Add an A4 page to the document.
            Page page = pdfDocument.Pages.Add(DXPaperKind.A4);

            float y = 750;
            float step = 30;
            float textHeight = 14f;

            // Create a checkbox field and add it to the field collection.
            CheckBoxField agreeField = new("AgreeToTerms");
            pdfDocument.Fields.Add(agreeField);

            // Bind the checkbox field to a widget and place it on the page.
            RectangleF agreeBounds = new(50, y - textHeight + 6, 18, 18);
            CheckBoxWidgetAnnotation agreeWidget = new(agreeField, agreeBounds);
            page.Annotations.Add(agreeWidget);
            y -= step;

            // Add a label for the checkbox field.
            TextFragment labelAgreeField = new() { Text = "Agree to terms", Location = new PointF(agreeBounds.X + 30, agreeBounds.Y + 6) };
            page.Fragments.Add(labelAgreeField);
        }
    }
}

VB.NET

Imports DevExpress.Docs.Pdf
Imports DevExpress.Drawing.Printing
Imports System.Drawing

Namespace ConsoleApp1

Public Class Program
    Public Shared Async Function Main(args As String()) As Task
        Using pdfDocument As New PdfDocument()
            ' Add an A4 page to the document.
            Dim page As Page = pdfDocument.Pages.Add(DXPaperKind.A4)

            Dim y As Single = 750
            Dim [step] As Single = 30
            Dim textHeight As Single = 14.0F

            ' Create a checkbox field and add it to the field collection.
            Dim agreeField As New CheckBoxField("AgreeToTerms")
            pdfDocument.Fields.Add(agreeField)

            ' Bind the checkbox field to a widget and place it on the page.
            Dim agreeBounds As New RectangleF(50, y - textHeight + 6, 18, 18)
            Dim agreeWidget As New CheckBoxWidgetAnnotation(agreeField, agreeBounds)
            page.Annotations.Add(agreeWidget)
            y -= [step]

            ' Add a label for the checkbox field.
            Dim labelAgreeField As New TextFragment() With {
                .Text = "Agree to terms",
                .Location = New PointF(agreeBounds.X + 30, agreeBounds.Y + 6)
            }
            page.Fragments.Add(labelAgreeField)
        End Using
    End Function
End Class

End Namespace

Implements

ICloneable

Inheritance

Object

FormField

CheckBoxField