PdfGraphicsAcroFormCheckBoxField Class

A check box field in PDF Graphics API.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v21.1.Drawing.dll

NuGet Package: DevExpress.Pdf.Drawing

Declaration

C#

public class PdfGraphicsAcroFormCheckBoxField :
    PdfGraphicsAcroFormCommonField

VB.NET

Public Class PdfGraphicsAcroFormCheckBoxField
    Inherits PdfGraphicsAcroFormCommonField

Remarks

To access the PdfGraphicsAcroFormCheckBoxField class, you need to reference the DevExpress.Pdf.Drawing.v21.1 assembly.

Tip

You can use the PdfAcroFormField class to add interactive form fields to a PDF file. Refer to the following article for more information: Interactive Forms in PDF Documents

Create a Form Field

To create a check box field, create a new PdfGraphicsAcroFormCheckBoxField object and pass the field name and location as the constructor parameters.

Specify Form Field Parameters

The following parameters are available:

Parameter	API
Form field name	Name
Tooltip text	ToolTip
Form field state (checked or unchecked)	IsChecked
Check box marker shape	ButtonStyle
Appearance settings (background and foreground color, font and border options)	Appearance

Add a Form Field as Graphics Content

To add a check box field as a graphics content, pass a PdfGraphicsAcroFormCheckBoxField object as a parameter to the PdfGraphics.AddFormField method.

Draw a Form Field on a Page

To draw an interactive field to a page, call one of the following methods:

• PdfGraphics.AddToPageForeground, PdfGraphics.AddToPageBackground – to add a field to an existing page;
• PdfDocumentProcessor.RenderNewPage – to add a field to a new page.

Example

This example shows how to use PDF Graphics API to create a check box field and add it to a new page.

View Example

Program.cs

using DevExpress.Pdf;
using System.Drawing;
//...
static void Main(string[] args)
{
    using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
    {
        // Create an empty document. 
        processor.CreateEmptyDocument("..\\..\\Result.pdf");

        // Create graphics and draw a check box field.
        using (PdfGraphics graphics = processor.CreateGraphics())
        {
            DrawCheckBoxField(graphics);

            // Render a page with graphics.
            processor.RenderNewPage(PdfPaperSize.Letter, graphics);
        }
    }
}

static void DrawCheckBoxField(PdfGraphics graphics)
{
    // Create a check box field specifying its name and location.
    PdfGraphicsAcroFormCheckBoxField checkBox = new PdfGraphicsAcroFormCheckBoxField("check box", new RectangleF(20, 20, 30, 30));

    // Specify check box appearance, checked state, and button style.
    checkBox.Appearance.BackgroundColor = Color.Azure;
    checkBox.Appearance.BorderAppearance = new PdfGraphicsAcroFormBorderAppearance()
    { Color = Color.Red };
    checkBox.IsChecked = true;
    checkBox.ButtonStyle = PdfAcroFormButtonStyle.Star;

    // Add the field to the document.
    graphics.AddFormField(checkBox);
}

Program.vb

Imports DevExpress.Pdf
Imports System.Drawing
'...
Shared Sub Main(ByVal args() As String)
    Using processor As New PdfDocumentProcessor()

        ' Create an empty document. 
        processor.CreateEmptyDocument("..\..\Result.pdf")

        ' Create graphics and draw a check box field.
        Using graphics As PdfGraphics = processor.CreateGraphics()
            DrawCheckBoxField(graphics)

            ' Render a page with graphics.
            processor.RenderNewPage(PdfPaperSize.Letter, graphics)
        End Using
    End Using
End Sub

Private Shared Sub DrawCheckBoxField(ByVal graphics As PdfGraphics)

    ' Create a check box field specifying its name and location.
    Dim checkBox As New PdfGraphicsAcroFormCheckBoxField("check box", New RectangleF(20, 20, 30, 30))

    ' Specify check box appearance, checked state, and button style.
    checkBox.Appearance.BackgroundColor = Color.Azure
    checkBox.Appearance.BorderAppearance = New PdfGraphicsAcroFormBorderAppearance() With {.Color = Color.Red}
    checkBox.IsChecked = True
    checkBox.ButtonStyle = PdfAcroFormButtonStyle.Star

    ' Add the field to the document.
    graphics.AddFormField(checkBox)
End Sub

Inheritance

Object

PdfGraphicsAcroFormField

PdfGraphicsAcroFormCommonField

PdfGraphicsAcroFormCheckBoxField