PdfGraphicsAcroFormComboBoxField Class

Represents a combo box field.

Namespace: DevExpress.Pdf

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

Declaration

C#

public class PdfGraphicsAcroFormComboBoxField :
    PdfGraphicsAcroFormChoiceField

VB.NET

Public Class PdfGraphicsAcroFormComboBoxField
    Inherits PdfGraphicsAcroFormChoiceField

Related API Members

The following members return PdfGraphicsAcroFormComboBoxField objects:

• PdfGraphicsAcroFormField.CreateComboBox(String, RectangleF)

Remarks

To create a combo box field, call the PdfGraphicsAcroFormField.CreateComboBox method with specified the field name and field rectangle.

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

You can specify the combo box name, tooltip and appearance using PdfGraphicsAcroFormField.Name, PdfGraphicsAcroFormField.ToolTip, PdfGraphicsAcroFormField.Appearance properties.

To select an item of a combo box by an export value, call the PdfAcroFormChoiceField.SelectValue method using this value.

To add a combo box field to PDF graphics, pass a PdfGraphicsAcroFormComboBoxField object representing the combo box field as a parameter to the PdfGraphics.AddFormField method. To access PdfGraphics, you need to reference the DevExpress.Pdf.Drawing assembly.

To render a page with the PDF graphics, call one of PdfDocumentProcessor.RenderNewPage overloaded methods.

Example

This example shows how to create a combo 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-combo-box-field-to-a-document-t494205

Program.cs

using DevExpress.Pdf;
using System.Drawing;


namespace AddComboBoxField {
    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 combo box field.
                using (PdfGraphics graphics = processor.CreateGraphics()) {
                    DrawComboBoxField(graphics);

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

        static void DrawComboBoxField(PdfGraphics graphics) {

            // Create a combo box field specifying its name and location.
            PdfGraphicsAcroFormComboBoxField comboBox = new PdfGraphicsAcroFormComboBoxField("combo Box", new RectangleF(20, 20, 100, 20));

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

            // Specify combo box selected value, text allignment, and appearance.
            comboBox.SelectValue("Red");
            comboBox.TextAlignment = PdfAcroFormStringAlignment.Far;
            comboBox.Appearance.BackgroundColor = Color.Beige;
            comboBox.Appearance.FontSize = 14;

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

Program.vb

Imports DevExpress.Pdf
Imports System.Drawing


Namespace AddComboBoxField
    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 combo box field.
                Using graphics As PdfGraphics = processor.CreateGraphics()
                    DrawComboBoxField(graphics)

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

        Private Shared Sub DrawComboBoxField(ByVal graphics As PdfGraphics)

            ' Create a combo box field specifying its name and location.
            Dim comboBox As New PdfGraphicsAcroFormComboBoxField("combo Box", New RectangleF(20, 20, 100, 20))

            ' Add values to the combo box.  
            comboBox.AddValue("Red")
            comboBox.AddValue("Yellow")
            comboBox.AddValue("Green")
            comboBox.AddValue("Blue")

            ' Specify combo box selected value, text allignment, and appearance.
            comboBox.SelectValue("Red")
            comboBox.TextAlignment = PdfAcroFormStringAlignment.Far
            comboBox.Appearance.BackgroundColor = Color.Beige
            comboBox.Appearance.FontSize = 14

            ' Add the field to the document.
            graphics.AddFormField(comboBox)
        End Sub
    End Class
End Namespace

Inheritance

Object

PdfGraphicsAcroFormField

PdfGraphicsAcroFormCommonField

PdfGraphicsAcroFormChoiceField

PdfGraphicsAcroFormComboBoxField