ListBoxWidgetAnnotation Class

Contains properties used to customize the list box field’s widget annotation.

Namespace: DevExpress.Docs.Pdf

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

NuGet Package: DevExpress.Docs.Pdf

Declaration

C#

public class ListBoxWidgetAnnotation :
    WidgetAnnotation

VB.NET

Public Class ListBoxWidgetAnnotation
    Inherits WidgetAnnotation

Remarks

A widget annotation contains a form field’s appearance and display properties. One field can be related to multiple widget annotations.

Use properties of the WidgetAnnotation base class to specify the form field widget settings.

Example

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

The following code snippet adds a list box field with three options to a PDF document and binds it to a list 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 list box field.
            ListBoxField listBoxField = new("listBox");

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

            // Add the list box field to the field collection.
            pdfDocument.Fields.Add(listBoxField);

            // Bind the list box field to a widget and set widget colors.
            ListBoxWidgetAnnotation listBoxWidget = new(listBoxField, bounds: new RectangleF(20, 620, 100, 30));
            listBoxWidget.BackgroundColor = PdfColor.White;
            listBoxWidget.OutlineColor = PdfColor.Red;

            page.Annotations.Add(listBoxWidget);
        }
    }
}

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 PdfDocument()
            ' Add an A4 page to the document.
            Dim page As Page = pdfDocument.Pages.Add(DXPaperKind.A4)

            ' Create a list box field.
            Dim listBoxField As New ListBoxField("listBox")

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

            ' Add the list box field to the field collection.
            pdfDocument.Fields.Add(listBoxField)

            ' Bind the list box field to a widget and set widget colors.
            Dim listBoxWidget As New ListBoxWidgetAnnotation(listBoxField, bounds:=New RectangleF(20, 620, 100, 30))
            listBoxWidget.BackgroundColor = PdfColor.White
            listBoxWidget.OutlineColor = PdfColor.Red

            page.Annotations.Add(listBoxWidget)
        End Using
    End Function
End Class

End Namespace

Implements

ICloneable

Inheritance

Object

BaseAnnotation

WidgetAnnotation

ListBoxWidgetAnnotation