PdfListBoxFormFieldFacade Class

Contains a set of properties used to manage list box form fields without access to their inner structure.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v21.1.Core.dll

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public class PdfListBoxFormFieldFacade :
    PdfChoiceFormFieldFacade<PdfListBoxWidgetFacade>

VB.NET

Public Class PdfListBoxFormFieldFacade
    Inherits PdfChoiceFormFieldFacade(Of PdfListBoxWidgetFacade)

Related API Members

The following members return PdfListBoxFormFieldFacade objects:

• PdfAcroFormFacade.GetListBoxFormField(String)

Remarks

Change Annotation Parameters

The code sample below specifies the list box value and disables multiple selection:

C#

using (PdfDocumentProcessor pdfDocumentProcessor = new PdfDocumentProcessor())
{
    pdfDocumentProcessor.LoadDocument("Documents//FormDemo.pdf");

    PdfDocumentFacade documentFacade = pdfDocumentProcessor.DocumentFacade;
    PdfAcroFormFacade acroForm = documentFacade.AcroForm;
    PdfListBoxFormFieldFacade listField = acroForm.GetListBoxFormField("List");
    listField.MultiSelect = false;
    listField.Sorted = false;
    listField.Values = new List<string>() { listField.Items[2].Value };}

VB.NET

Using pdfDocumentProcessor As New PdfDocumentProcessor()
  pdfDocumentProcessor.LoadDocument("Documents//FormDemo.pdf")

  Dim documentFacade As PdfDocumentFacade = pdfDocumentProcessor.DocumentFacade
  Dim acroForm As PdfAcroFormFacade = documentFacade.AcroForm
  Dim listField As PdfListBoxFormFieldFacade = acroForm.GetListBoxFormField("List")
  listField.MultiSelect = False
  listField.Sorted = False
  listField.Values = New List(Of String)() From {listField.Items(2).Value}
End Using

Change Widget Annotation Options

A widget annotation contains a form field’s appearance and display properties. One field can be related to multiple widget annotations. Use the Widgets property to get the form field widget settings.

The code sample below changes the list box appearance:

C#

using (PdfDocumentProcessor pdfDocumentProcessor = new PdfDocumentProcessor())
{
    pdfDocumentProcessor.LoadDocument("Documents//FormDemo.pdf");

    PdfDocumentFacade documentFacade = pdfDocumentProcessor.DocumentFacade;
    PdfAcroFormFacade acroForm = documentFacade.AcroForm;
    PdfListBoxFormFieldFacade listField = acroForm.GetListBoxFormField("List");

    PdfListBoxWidgetFacade listBoxWidget = listField.Widgets[0];
    listBoxWidget.BorderWidth = 1;
    listBoxWidget.BackgroundColor = new PdfRGBColor(0.81, 0.81, 0.81);
    listBoxWidget.BorderColor = new PdfRGBColor(0.47, 0.44, 0.67);
    listBoxWidget.FontColor = new PdfRGBColor(0.34, 0.25, 0.36);
}

VB.NET

Using pdfDocumentProcessor As New PdfDocumentProcessor()
  pdfDocumentProcessor.LoadDocument("Documents//FormDemo.pdf")

  Dim documentFacade As PdfDocumentFacade = pdfDocumentProcessor.DocumentFacade
  Dim acroForm As PdfAcroFormFacade = documentFacade.AcroForm
  Dim listField As PdfListBoxFormFieldFacade = acroForm.GetListBoxFormField("List")

  Dim listBoxWidget As PdfListBoxWidgetFacade = listField.Widgets(0)
  listBoxWidget.BorderWidth = 1
  listBoxWidget.BackgroundColor = New PdfRGBColor(0.81, 0.81, 0.81)
  listBoxWidget.BorderColor = New PdfRGBColor(0.47, 0.44, 0.67)
  listBoxWidget.FontColor = New PdfRGBColor(0.34, 0.25, 0.36)
End Using

Inheritance

Object

PdfFormFieldFacade

PdfFormFieldFacade<PdfListBoxWidgetFacade, PdfChoiceFormField>

PdfChoiceFormFieldFacade<PdfListBoxWidgetFacade>

PdfListBoxFormFieldFacade