PdfGraphicsAcroFormBorderAppearance Class

Provides appearance settings used to paint the border of an interactive form field.

Namespace: DevExpress.Pdf

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

Declaration

C#

public class PdfGraphicsAcroFormBorderAppearance

VB.NET

Public Class PdfGraphicsAcroFormBorderAppearance

Related API Members

The following members return PdfGraphicsAcroFormBorderAppearance objects:

• PdfGraphicsAcroFormFieldAppearance.BorderAppearance

Remarks

The PdfGraphicsAcroFormBorderAppearance class contains properties (e.g., PdfGraphicsAcroFormBorderAppearance.Color, PdfGraphicsAcroFormBorderAppearance.Style) that can be used to paint the border of an interactive form field.

To specify the border appearance settings, use the PdfGraphicsAcroFormFieldAppearance.BorderAppearance property.

To access the PdfGraphicsAcroFormFieldAppearance class, use the PdfGraphicsAcroFormField.Appearance property.

Example

This example shows how to create a check box field and add it to a PDF document using the Document Creation API.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-add-a-check-box-field-to-a-document-t494186

Program.cs

using DevExpress.Pdf;
using System.Drawing;

namespace AddCheckBoxField {
    class Program {
        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

Namespace AddCheckBoxField
    Friend Class Program
        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
    End Class
End Namespace

Inheritance

Object

PdfGraphicsAcroFormBorderAppearance