PdfCheckBoxFormFieldFacade Class

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

Namespace: DevExpress.Pdf

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

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public class PdfCheckBoxFormFieldFacade :
    PdfFormFieldFacade<PdfCheckBoxWidgetFacade, PdfButtonFormField>

VB.NET

Public Class PdfCheckBoxFormFieldFacade
    Inherits PdfFormFieldFacade(Of PdfCheckBoxWidgetFacade, PdfButtonFormField)

Related API Members

The following members return PdfCheckBoxFormFieldFacade objects:

• PdfAcroFormFacade.GetCheckBoxFormField(String)

Remarks

The PdfCheckBoxFormFieldFacade 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 check box’s marker style:

C#

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

    PdfDocumentFacade documentFacade = pdfDocumentProcessor.DocumentFacade;
    PdfAcroFormFacade acroForm = documentFacade.AcroForm;
    PdfCheckBoxFormFieldFacade genderField = acroForm.GetCheckBoxFormField("Gender");
    genderField.ToggleToOff = true;

    foreach (PdfCheckBoxWidgetFacade widget in genderField.Widgets)
    {
        widget.ButtonStyle = PdfAcroFormButtonStyle.Square;
    }
}

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 genderField As PdfCheckBoxFormFieldFacade = acroForm.GetCheckBoxFormField("Gender")
  genderField.ToggleToOff = True

  For Each widget As PdfCheckBoxWidgetFacade In genderField.Widgets
    widget.ButtonStyle = PdfAcroFormButtonStyle.Square
  Next widget
End Using

Inheritance

Object

PdfFormFieldFacade

PdfFormFieldFacade<PdfCheckBoxWidgetFacade, PdfButtonFormField>

PdfCheckBoxFormFieldFacade