Skip to main content
.NET Framework 4.5.2+

PdfGraphicsAcroFormTextBoxField Class

A text box field in PDF Graphics API.

Namespace: DevExpress.Pdf

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

Declaration

public class PdfGraphicsAcroFormTextBoxField :
    PdfGraphicsAcroFormCommonField

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.v22.1 assembly.

Draw a Form Field on a Page

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

Example

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

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);
}

The following code snippets (auto-collected from DevExpress Examples) contain references to the PdfGraphicsAcroFormTextBoxField class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

Inheritance

See Also