PdfGraphicsAcroFormChoiceField.AddValue(String) Method

Adds an item with the specified display value to a combo box or a list box field.

Namespace: DevExpress.Pdf

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

NuGet Package: DevExpress.Pdf.Drawing

Declaration

C#

public void AddValue(
    string displayValue
)

VB.NET

Public Sub AddValue(
    displayValue As String
)

Parameters

Name	Type	Description
displayValue	String	A String that is a value to be added to combo box and list box.

Remarks

The export value of an added item is equal to the display value.

Example

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

View Example

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 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
    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 alignment, 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
'...


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
    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 alignment, 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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AddValue(String) method.

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.

C#

pdf-document-api-create-combo-box-field/CS/AddComboBoxField/Program.cs#L29

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

pdf-document-api-create-list-box-field/CS/AddListBoxField/Program.cs#L29

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

VB.NET

pdf-document-api-create-combo-box-field/VB/AddComboBoxField/Program.vb#L25

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

pdf-document-api-create-list-box-field/VB/AddListBoxField/Program.vb#L25

' Add values to the list box.
listBox.AddValue("Blue")
listBox.AddValue("Green")