Back to Devexpress

PdfComboBoxFormFieldFacade Class

officefileapi-devexpress-dot-pdf-8f608a1b.md

latest5.2 KB
Original Source

PdfComboBoxFormFieldFacade Class

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

Namespace : DevExpress.Pdf

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

NuGet Package : DevExpress.Pdf.Core

Declaration

csharp
public class PdfComboBoxFormFieldFacade :
    PdfChoiceFormFieldFacade<PdfComboBoxWidgetFacade>
vb
Public Class PdfComboBoxFormFieldFacade
    Inherits PdfChoiceFormFieldFacade(Of PdfComboBoxWidgetFacade)

The following members return PdfComboBoxFormFieldFacade objects:

Remarks

Change Annotation Parameters

The code sample below specifies the combo box value, disables user input, and sorts list items alphabetically:

csharp
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;

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

  'Sort list items alphabetically:
  nationalityField.Sorted = True
End Using

Change Widget Annotation Options

Use the Widgets property to get the form field widget settings. The PdfComboBoxWidgetFacade class properties allow you to change the form field’s appearance.

csharp
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");

    PdfComboBoxWidgetFacade comboBoxWidget = nationalityField.Widgets[0];
    comboBoxWidget.BorderWidth = 1;
    comboBoxWidget.BackgroundColor = new PdfRGBColor(0.81, 0.81, 0.81);
    comboBoxWidget.BorderColor = new PdfRGBColor(0.47, 0.44, 0.67);
    comboBoxWidget.FontColor = new PdfRGBColor(0.34, 0.25, 0.36);
}
vb
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")

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

Implements

IEnumerable<PdfWidgetFacade>

IEnumerable

Inheritance

Object PdfFormFieldFacade PdfFormFieldFacade<PdfComboBoxWidgetFacade, PdfChoiceFormField> PdfChoiceFormFieldFacade<PdfComboBoxWidgetFacade> PdfComboBoxFormFieldFacade

See Also

PdfComboBoxFormFieldFacade Members

DevExpress.Pdf Namespace