RadioGroupField Class

A radio group field is a form field that contains a set of options, only one of which can be selected.

Namespace: DevExpress.Docs.Pdf

Assembly: DevExpress.Docs.Pdf.v26.1.dll

Declaration

C#

public class RadioGroupField :
    FormField

VB.NET

Public Class RadioGroupField
    Inherits FormField

Related API Members

The following members return RadioGroupField objects:

• RadioGroupItemWidgetAnnotation.Group

Remarks

For more information, refer to the following help topic: DevExpress PDF Document API - Form Fields.

Example

How to: Add a Radio Group Field to a PDF Document

The following code snippet adds a radio button group with three options to a PDF document:

C#

using DevExpress.Docs.Pdf;
using DevExpress.Drawing.Printing;
using System.Drawing;

namespace ConsoleApp1;

public class Program {
    public static async Task Main(string[] _) {
        using (PdfDocument pdfDocument = new()) {
            // Add an A4 page to the document.
            Page page = pdfDocument.Pages.Add(DXPaperKind.A4);

            float y = 750;
            float step = 30;
            float textHeight = 14f;

            // Create a radio group field and add it to the field collection.
            RadioGroupField radioGroupField = new("radioGroup");
            pdfDocument.Fields.Add(radioGroupField);

            // Add the first radio button widget and its label.
            RectangleF radioBounds1 = new(50, y - textHeight + 6, 18, 18);
            RadioGroupItemWidgetAnnotation radioGroupItem1 = new(radioGroupField, "Option1", radioBounds1);
            y -= step;
            page.Annotations.Add(radioGroupItem1);

            TextFragment label1 = new() { Text = "Option #1", Location = new PointF(radioBounds1.X + 30, radioBounds1.Y + 6) };
            page.Fragments.Add(label1);

            // Add the second radio button widget and its label.
            RectangleF radioBounds2 = new(50, y - textHeight + 6, 18, 18);
            RadioGroupItemWidgetAnnotation radioGroupItem2 = new(radioGroupField, "Option2", radioBounds2);
            page.Annotations.Add(radioGroupItem2);
            y -= step;

            TextFragment label2 = new() { Text = "Option #2", Location = new PointF(radioBounds2.X + 30, radioBounds2.Y + 6) };
            page.Fragments.Add(label2);


            // Add the third radio button widget and its label.
            RectangleF radioBounds3 = new(50, y - textHeight + 6, 18, 18);
            RadioGroupItemWidgetAnnotation radioGroupItem3 = new(radioGroupField, "Option3", radioBounds3);
            page.Annotations.Add(radioGroupItem3);
            y -= step;

            // Set the default selected value.
            radioGroupField.Value = "Option3";

            TextFragment label3 = new() { Text = "Option #3", Location = new PointF(radioBounds3.X + 30, radioBounds3.Y + 6) };
            page.Fragments.Add(label3);

            // Save the document to a file.
            FileStream outputStream = new FileStream(@"D:\doc.pdf", FileMode.Create);
            pdfDocument.Save(outputStream);
            outputStream.Dispose();
        }
    }
}

VB.NET

Imports DevExpress.Docs.Pdf
Imports DevExpress.Drawing.Printing
Imports System.Drawing
Imports System.IO

Namespace ConsoleApp1

Public Class Program
    Public Shared Async Function Main(args As String()) As Task
        Using pdfDocument As New PdfDocument()
            ' Add an A4 page to the document.
            Dim page As Page = pdfDocument.Pages.Add(DXPaperKind.A4)

            Dim y As Single = 750
            Dim [step] As Single = 30
            Dim textHeight As Single = 14.0F

            ' Create a radio group field and add it to the field collection.
            Dim radioGroupField As New RadioGroupField("radioGroup")
            pdfDocument.Fields.Add(radioGroupField)

            ' Add the first radio button widget and its label.
            Dim radioBounds1 As New RectangleF(50, y - textHeight + 6, 18, 18)
            Dim radioGroupItem1 As New RadioGroupItemWidgetAnnotation(radioGroupField, "Option1", radioBounds1)
            y -= [step]
            page.Annotations.Add(radioGroupItem1)

            Dim label1 As New TextFragment() With {
                .Text = "Option #1",
                .Location = New PointF(radioBounds1.X + 30, radioBounds1.Y + 6)
            }
            page.Fragments.Add(label1)

            ' Add the second radio button widget and its label.
            Dim radioBounds2 As New RectangleF(50, y - textHeight + 6, 18, 18)
            Dim radioGroupItem2 As New RadioGroupItemWidgetAnnotation(radioGroupField, "Option2", radioBounds2)
            page.Annotations.Add(radioGroupItem2)
            y -= [step]

            Dim label2 As New TextFragment() With {
                .Text = "Option #2",
                .Location = New PointF(radioBounds2.X + 30, radioBounds2.Y + 6)
            }
            page.Fragments.Add(label2)

            ' Add the third radio button widget and its label.
            Dim radioBounds3 As New RectangleF(50, y - textHeight + 6, 18, 18)
            Dim radioGroupItem3 As New RadioGroupItemWidgetAnnotation(radioGroupField, "Option3", radioBounds3)
            page.Annotations.Add(radioGroupItem3)
            y -= [step]

            ' Set the default selected value.
            radioGroupField.Value = "Option3"

            Dim label3 As New TextFragment() With {
                .Text = "Option #3",
                .Location = New PointF(radioBounds3.X + 30, radioBounds3.Y + 6)
            }
            page.Fragments.Add(label3)

            ' Save the document to a file.
            Dim outputStream As New FileStream("D:\doc.pdf", FileMode.Create)
            pdfDocument.Save(outputStream)
            outputStream.Dispose()
        End Using
    End Function
End Class

End Namespace

Implements

ICloneable

Inheritance

Object

FormField

RadioGroupField