.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

PdfGraphicsAcroFormListBoxField Class

A list box field in PDF Graphics API.

Namespace: DevExpress.Pdf

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

Declaration

public class PdfGraphicsAcroFormListBoxField :
    PdfGraphicsAcroFormChoiceField

Remarks

To access the PdfGraphicsAcroFormComboBoxField class, you need to reference the DevExpress.Pdf.Drawing.v21.2 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 List Box Field

To create a list box form field, create a new PdfGraphicsAcroFormListBoxField instance, and pass the field name and page location as constructor parameters. The page location is calculated in the world coordinate system.

You can also call the CreateListBox method to create a list box form field.

To add values to the list box, call one of the PdfGraphicsAcroFormChoiceField.AddValue overloaded methods.

Specify Form Field Parameters

The following parameters are available:

Parameter API
Form field name Name
Tooltip text ToolTip
Selected item (by index) SetSelected(Int32, Boolean)
Selected item (by export value) SelectValue(String)
Multiple selection MultiSelect
Appearance settings (background and foreground color, font and border options) Appearance

Add a Form Field as Graphics Content

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

Draw a List Box Field on a Page

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

Example

This example shows how to use PDF Graphics API to create a list box field and add it to a new PDF 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 graphics and draw a list box field.
        using (PdfGraphics graphics = processor.CreateGraphics())
        {
            DrawListBoxField(graphics);

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

static void DrawListBoxField(PdfGraphics graphics)
{
    // Create a list box field
    PdfGraphicsAcroFormListBoxField listBox = new PdfGraphicsAcroFormListBoxField("list box", new RectangleF(20, 20, 100, 120));

    // Add values to the list box.
    listBox.AddValue("Blue");
    listBox.AddValue("Green");
    listBox.AddValue("Red");
    listBox.AddValue("Yellow");

    // Specify list box parameters. 
    listBox.Appearance.BackgroundColor = Color.Aqua;
    listBox.TextAlignment = PdfAcroFormStringAlignment.Far;
    listBox.SelectValue("Blue");

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

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PdfGraphicsAcroFormListBoxField 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.

See Also