PdfGraphicsAcroFormRadioGroupField.AddButton(String, RectangleF) Method

Adds a radio button to the radio group field using the radio button name and a rectangle that specifies the location of this button on a PDF page.

Namespace: DevExpress.Pdf

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

Declaration

C#

public void AddButton(
    string name,
    RectangleF rect
)

VB.NET

Public Sub AddButton(
    name As String,
    rect As RectangleF
)

Parameters

Name	Type	Description
name	String	A String that specifies the name of a radio button.
rect	RectangleF	A RectangleF object that represents a rectangle inside which a radio button is located on a page.

Example

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

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-add-a-radio-button-field-to-a-document-t494168

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);
        }
    }
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AddButton(String, RectangleF) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

pdf-document-api-create-radio-button-group-field/CS/AddRadioButtonField/Program.cs#L28

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

VB.NET

pdf-document-api-create-radio-button-group-field/VB/AddRadioButtonField/Program.vb#L25

' 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.

pdf-document-api-create-interactive-form/VB/AddFormFieldsToNewDocument/Program.vb#L33

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