PdfRadioGroupFormFieldFacade Class

Contains a set of properties used to manage radio group 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 PdfRadioGroupFormFieldFacade :
    PdfFormFieldFacade<PdfRadioButtonWidgetFacade, PdfButtonFormField>

VB.NET

Public Class PdfRadioGroupFormFieldFacade
    Inherits PdfFormFieldFacade(Of PdfRadioButtonWidgetFacade, PdfButtonFormField)

Related API Members

The following members return PdfRadioGroupFormFieldFacade objects:

• PdfAcroFormFacade.GetRadioGroupFormField(String)

Remarks

The code sample below specifies the radio group value:

C#

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

    PdfDocumentFacade documentFacade = pdfDocumentProcessor.DocumentFacade;
    PdfAcroFormFacade acroForm = documentFacade.AcroForm;

    //Set the radio group value:
    PdfRadioGroupFormFieldFacade genderField = acroForm.GetRadioGroupFormField("Gender");
    genderField.Value = genderField.Field.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

  'Set the radio group value:
  Dim genderField As PdfRadioGroupFormFieldFacade = acroForm.GetRadioGroupFormField("Gender")
  genderField.Value = genderField.Field.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 widget settings of each radio button in the group.

Note

The FontName, FontSize, FontBold and FontItalic properties do not affect the radio button appearance.

The code sample below changes the radio button style and color settings:

C#

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

    PdfDocumentFacade documentFacade = pdfDocumentProcessor.DocumentFacade;
    PdfAcroFormFacade acroForm = documentFacade.AcroForm;
    PdfRadioGroupFormFieldFacade genderField = acroForm.GetRadioGroupFormField("Gender");

    //Change marker style for all radio buttons:
    foreach (PdfRadioButtonWidgetFacade widget in genderField.Widgets)
    {
        widget.ButtonStyle = PdfAcroFormButtonStyle.Square;
        widget.BorderWidth = 1;
        widget.BackgroundColor = new PdfRGBColor(0.81, 0.81, 0.81);
        widget.BorderColor = new PdfRGBColor(0.47, 0.44, 0.67);
        widget.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 genderField As PdfRadioGroupFormFieldFacade = acroForm.GetRadioGroupFormField("Gender")

  'Change marker style for all radio buttons:
  For Each widget As PdfRadioButtonWidgetFacade In genderField.Widgets
    widget.ButtonStyle = PdfAcroFormButtonStyle.Square
    widget.BorderWidth = 1
    widget.BackgroundColor = New PdfRGBColor(0.81, 0.81, 0.81)
    widget.BorderColor = New PdfRGBColor(0.47, 0.44, 0.67)
    widget.FontColor = New PdfRGBColor(0.34, 0.25, 0.36)
  Next widget
End Using

Inheritance

Object

PdfFormFieldFacade

PdfFormFieldFacade<PdfRadioButtonWidgetFacade, PdfButtonFormField>

PdfRadioGroupFormFieldFacade