PdfAcroFormFacade.GetListBoxFormField(String) Method

Gets a specific list box form field’s properties.

Namespace: DevExpress.Pdf

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

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public PdfListBoxFormFieldFacade GetListBoxFormField(
    string fullName
)

VB.NET

Public Function GetListBoxFormField(
    fullName As String
) As PdfListBoxFormFieldFacade

Parameters

Name	Type	Description
fullName	String	A form field’s name.

Returns

Type	Description
PdfListBoxFormFieldFacade	An object that contains the form field’s properties.

Remarks

The PdfListBoxFormFieldFacade object contains form field and widget properties without access to the form field’s inner structure. Use the Widgets property to get the widget annotations’ settings associated with the form field.

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.Value = listField.Items[2].Value;
    pdfDocumentProcessor.SaveDocument("FormDemo_new.pdf");
}

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.Value = listField.Items(2).Value
  pdfDocumentProcessor.SaveDocument("FormDemo_new.pdf")
End Using