PdfAcroFormFacade.GetComboBoxFormField(String) Method

Gets a specific combo box form field’s properties.

Namespace: DevExpress.Pdf

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

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public PdfComboBoxFormFieldFacade GetComboBoxFormField(
    string fullName
)

VB.NET

Public Function GetComboBoxFormField(
    fullName As String
) As PdfComboBoxFormFieldFacade

Parameters

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

Returns

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

Remarks

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

The code sample below specifies the combo 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;

    //Set combo box field value:
    PdfComboBoxFormFieldFacade nationalityField = acroForm.GetComboBoxFormField("Nationality");
    nationalityField.Value = nationalityField.Items[68].Value;

    //Disable user input:
    nationalityField.Editable = false;

    //Disable multiple selection:
    nationalityField.MultiSelect = false;

    //Sort list items alphabetically:
    nationalityField.Sorted = true;
    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

  'Set combo box field value:
  Dim nationalityField As PdfComboBoxFormFieldFacade = acroForm.GetComboBoxFormField("Nationality")
  nationalityField.Value = nationalityField.Items(68).Value

  'Disable user input:
  nationalityField.Editable = False

  'Disable multiple selection:
  nationalityField.MultiSelect = False

  'Sort list items alphabetically:
  nationalityField.Sorted = True
  pdfDocumentProcessor.SaveDocument("FormDemo_new.pdf")
End Using