PdfGraphicsAcroFormChoiceField.SelectValue(String) Method

Selects an item of a combo box and list box by their export value.

Namespace: DevExpress.Pdf

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

Declaration

C#

public bool SelectValue(
    string exportValue
)

VB.NET

Public Function SelectValue(
    exportValue As String
) As Boolean

Parameters

Name	Type	Description
exportValue	String	A String value that represents the item’s export value.

Returns

Type	Description
Boolean	true, if the combo box or list box item was successfully selected; otherwise, false.

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SelectValue(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#L35

// Specify combo box selected value, text allignment, and appearance.
comboBox.SelectValue("Red");
comboBox.TextAlignment = PdfAcroFormStringAlignment.Far;

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

listBox.TextAlignment = PdfAcroFormStringAlignment.Far;
listBox.SelectValue("Blue");

VB.NET

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

' Specify combo box selected value, text allignment, and appearance.
comboBox.SelectValue("Red")
comboBox.TextAlignment = PdfAcroFormStringAlignment.Far

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

listBox.TextAlignment = PdfAcroFormStringAlignment.Far
listBox.SelectValue("Blue")
' Add the field to the document.