PdfGraphicsAcroFormTextBoxField Class

A text box field in PDF Graphics API.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v23.2.Drawing.dll

NuGet Package: DevExpress.Pdf.Drawing

Declaration

C#

public class PdfGraphicsAcroFormTextBoxField :
    PdfGraphicsAcroFormCommonField

VB.NET

Public Class PdfGraphicsAcroFormTextBoxField
    Inherits PdfGraphicsAcroFormCommonField

Related API Members

The following members return PdfGraphicsAcroFormTextBoxField objects:

• PdfGraphicsAcroFormField.CreateTextBox(String, RectangleF)

Remarks

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

Create a new PdfGraphicsAcroFormTextBoxField object, and pass the field name and location as constructor parameters. The field location is calculated in the world coordinate system.

You can also call the PdfGraphicsAcroFormField.CreateTextBox method to create a new PdfGraphicsAcroFormTextBoxField object.

Specify Form Field Parameters

The following parameters are available:

Parameter	API
Text displayed in the form field	Text
Input type	PdfGraphicsAcroFormTextBoxField.Type
Enable multiline text	Multiline
Form field name	Name
Tooltip text	ToolTip
Appearance settings (background and foreground color, font and border options)	Appearance

Add a Form Field as a Graphics Content

To add a text box field as graphics content, pass the PdfGraphicsAcroFormTextBoxField object as a parameter to the PdfGraphics.AddFormField method. To access PdfGraphics, reference the DevExpress.Pdf.Drawing.v23.2 assembly.

Draw a Form Field on a Page

To draw an interactive field on 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 text box field and add it to a new page.

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 and draw a text box field.
        using (PdfGraphics graphics = processor.CreateGraphics())
        {
            DrawTextBoxField(graphics);

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

static void DrawTextBoxField(PdfGraphics graphics)
{
    // Create a text box field and specify its location.
    PdfGraphicsAcroFormTextBoxField textBox =
        new PdfGraphicsAcroFormTextBoxField("text box", new RectangleF(0, 10, 200, 30));

    // Specify text box properties.
    textBox.Text = "Text Box";           
    textBox.TextAlignment = PdfAcroFormStringAlignment.Near;
    textBox.Appearance.FontSize = 12;
    textBox.Appearance.BackgroundColor = Color.AliceBlue;          

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

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 and draw a text box field.
        Using graphics As PdfGraphics = processor.CreateGraphics()
            DrawTextBoxField(graphics)

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

Private Shared Sub DrawTextBoxField(ByVal graphics As PdfGraphics)

    ' Create a text box field and specify its location.
    Dim textBox As New PdfGraphicsAcroFormTextBoxField("text box", New RectangleF(0, 10, 200, 30))

    ' Specify text box properties.
    textBox.Text = "Text Box"
    textBox.TextAlignment = PdfAcroFormStringAlignment.Near
    textBox.Appearance.FontSize = 12
    textBox.Appearance.BackgroundColor = Color.AliceBlue

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

Inheritance

Object

PdfGraphicsAcroFormField

PdfGraphicsAcroFormCommonField

PdfGraphicsAcroFormTextBoxField