ComboBoxField Class

A combo box form field that allows users to select an option from a drop-down list in a PDF document.

Namespace: DevExpress.Docs.Pdf

Assembly: DevExpress.Docs.Pdf.v26.1.dll

Declaration

C#

public class ComboBoxField :
    ChoiceField

VB.NET

Public Class ComboBoxField
    Inherits ChoiceField

Remarks

For more information, refer to the following help topic: DevExpress PDF Document API - Form Fields.

Example

How to: Add a Combo Box Field to a PDF Document

The following code snippet adds a combo box field with three options to a PDF document and binds it to a combo box widget:

C#

using DevExpress.Docs.Pdf;
using DevExpress.Drawing.Printing;
using System.Drawing;

namespace ConsoleApp1;

public class Program {
    public static async Task Main(string[] _) {
        using (PdfDocument pdfDocument = new()) {
            // Add an A4 page to the document.
            Page page = pdfDocument.Pages.Add(DXPaperKind.A4);

            // Create a combo box field.
            ComboBoxField comboBoxField = new("comboBox");

            // Add items to the combo box field.
            comboBoxField.Items.Add(new ChoiceFieldItem("Option #1"));
            comboBoxField.Items.Add(new ChoiceFieldItem("Option #2"));
            comboBoxField.Items.Add(new ChoiceFieldItem("Option #3"));

            // Add the combo box field to the field collection.
            pdfDocument.Fields.Add(comboBoxField);

            // Set the default selected value.
            comboBoxField.Value = "Option #2";

            // Bind the combo box field to a widget and place it on the page.
            ComboBoxWidgetAnnotation comboBoxWidget = new(comboBoxField, bounds: new RectangleF(20, 700, 100, 30));
            page.Annotations.Add(comboBoxWidget);
        }
    }
}

VB.NET

Imports DevExpress.Docs.Pdf
Imports DevExpress.Drawing.Printing
Imports System.Drawing

Namespace ConsoleApp1

Public Class Program
    Public Shared Async Function Main(args As String()) As Task
        Using pdfDocument As New DevExpress.Docs.Pdf.PdfDocument()
            ' Add an A4 page to the document.
            Dim page As Page = pdfDocument.Pages.Add(DXPaperKind.A4)

            ' Create a combo box field.
            Dim comboBoxField As New ComboBoxField("comboBox")

            ' Add items to the combo box field.
            comboBoxField.Items.Add(New ChoiceFieldItem("Option #1"))
            comboBoxField.Items.Add(New ChoiceFieldItem("Option #2"))
            comboBoxField.Items.Add(New ChoiceFieldItem("Option #3"))

            ' Add the combo box field to the field collection.
            pdfDocument.Fields.Add(comboBoxField)

            ' Set the default selected value.
            comboBoxField.Value = "Option #2"

            ' Bind the combo box field to a widget and place it on the page.
            Dim comboBoxWidget As New ComboBoxWidgetAnnotation(comboBoxField, bounds:=New RectangleF(20, 700, 100, 30))
            page.Annotations.Add(comboBoxWidget)
        End Using
    End Function
End Class

End Namespace

Implements

ICloneable

Inheritance

Object

FormField

ChoiceField

ComboBoxField