PdfGraphicsAcroFormRadioGroupField Class

Represents a radio group field.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v20.2.Drawing.dll

NuGet Package: DevExpress.Pdf.Drawing

NuGet Packages: DevExpress.Pdf.Drawing, DevExpress.WindowsDesktop.Pdf.Drawing

Declaration

C#

public class PdfGraphicsAcroFormRadioGroupField :
    PdfGraphicsAcroFormField

VB.NET

Public Class PdfGraphicsAcroFormRadioGroupField
    Inherits PdfGraphicsAcroFormField

Related API Members

The following members return PdfGraphicsAcroFormRadioGroupField objects:

• PdfGraphicsAcroFormField.CreateRadioGroup(String)

Remarks

To create a radio group field, call the PdfGraphicsAcroFormField.CreateRadioGroup method with the specified the field name.

To add a button to the radio group field, call the PdfGraphicsAcroFormRadioGroupField.AddButton method.

Use members of the PdfGraphicsAcroFormRadioGroupField class to specify the radio group field properties. For example, to specify the radio group field’s selected index and button style, use PdfGraphicsAcroFormRadioGroupField.SelectedIndex, and PdfGraphicsAcroFormRadioGroupField.ButtonStyle properties.

To specify the radio group field name, tooltip and appearance, use the PdfGraphicsAcroFormField.Name, PdfGraphicsAcroFormField.ToolTip, PdfGraphicsAcroFormField.Appearance properties.

To add a radio group field to PDF graphics, pass a PdfGraphicsAcroFormRadioGroupField object representing the radio group field as a parameter to the PdfGraphics.AddFormField method. To access PdfGraphics, you need to reference the DevExpress.Pdf.Drawing assembly.

To render a page with the PDF graphics, call one of PdfDocumentProcessor.RenderNewPage overloaded methods.

Example

This example shows how to create a radio button group field and add it to a PDF document using the Document Creation API.

View Example

Program.vb

Imports DevExpress.Pdf
Imports System.Drawing

Namespace AddRadioButtonField
    Friend Class Program
        Shared Sub Main(ByVal args() As String)
            Using processor As New PdfDocumentProcessor()

                ' Create an empty document. 
                processor.CreateEmptyDocument("..\..\Result.pdf")

                ' Create graphics and draw a radio button field.
                Using graphics As PdfGraphics = processor.CreateGraphics()
                    DrawRadioButtonGroupField(graphics)

                    ' Render a page with graphics.
                    processor.RenderNewPage(PdfPaperSize.Letter, graphics)
                End Using
            End Using
        End Sub

        Private Shared Sub DrawRadioButtonGroupField(ByVal graphics As PdfGraphics)

            ' Create a radio group field.
            Dim radioGroup As New PdfGraphicsAcroFormRadioGroupField("First Group")

            ' Add the first radio button and specify its location using a RectangleF object.
            radioGroup.AddButton("button1", New RectangleF(0, 0, 20, 20))

            ' Add the second radio button.
            radioGroup.AddButton("button2", New RectangleF(0, 20, 20, 20))

            ' Specify radio group selected index, style and appearance.  
            radioGroup.SelectedIndex = 1
            radioGroup.ButtonStyle = PdfAcroFormButtonStyle.Circle
            radioGroup.Appearance.BackgroundColor = Color.Aqua
            radioGroup.Appearance.BorderAppearance = New PdfGraphicsAcroFormBorderAppearance() With {.Color = Color.Red, .Width = 3}

            ' Add the field to graphics.
            graphics.AddFormField(radioGroup)
        End Sub
    End Class
End Namespace

Program.cs

using DevExpress.Pdf;
using System.Drawing;

namespace AddRadioButtonField {
    class Program {
        static void Main(string[] args) {
            using (PdfDocumentProcessor processor = new PdfDocumentProcessor()) {

                // Create an empty document. 
                processor.CreateEmptyDocument("..\\..\\Result.pdf");

                // Create graphics and draw a radio button field.
                using (PdfGraphics graphics = processor.CreateGraphics()) {
                    DrawRadioButtonGroupField(graphics);

                    // Render a page with graphics.
                    processor.RenderNewPage(PdfPaperSize.Letter, graphics);
                }
            }
        }

        static void DrawRadioButtonGroupField(PdfGraphics graphics) {

            // Create a radio group field.
            PdfGraphicsAcroFormRadioGroupField radioGroup = new PdfGraphicsAcroFormRadioGroupField("First Group");

            // Add the first radio button and specify its location using a RectangleF object.
            radioGroup.AddButton("button1", new RectangleF(0, 0, 20, 20));

            // Add the second radio button.
            radioGroup.AddButton("button2", new RectangleF(0, 20, 20, 20));

            // Specify radio group selected index, style and appearance.  
            radioGroup.SelectedIndex = 1;
            radioGroup.ButtonStyle = PdfAcroFormButtonStyle.Circle;
            radioGroup.Appearance.BackgroundColor = Color.Aqua;
            radioGroup.Appearance.BorderAppearance = new PdfGraphicsAcroFormBorderAppearance() { Color = Color.Red, Width = 3 };

            // Add the field to graphics.
            graphics.AddFormField(radioGroup);
        }
    }
}

Inheritance

Object

PdfGraphicsAcroFormField

PdfGraphicsAcroFormRadioGroupField