PdfGraphicsAcroFormRadioGroupField.AddButton(String, RectangleF, String) Method

Adds a radio button with the specified name to the radio group field and places it in the specified page area.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v25.1.Drawing.dll

NuGet Package: DevExpress.Pdf.Drawing

Declaration

C#

public void AddButton(
    string name,
    RectangleF rect,
    string toolTip = null
)

VB.NET

Public Sub AddButton(
    name As String,
    rect As RectangleF,
    toolTip As String = Nothing
)

Parameters

Name	Type	Description
name	String	A name for a radio button.
rect	RectangleF	A page rectangle in the world coordinate system where you can draw the radio button.

Optional Parameters

Name	Type	Default	Description
toolTip	String	null	The radio button tooltip.

Remarks

To remove all radio buttons, call the ClearButtons() method.

Example

The following code snippet uses PDF Graphics API to create a radio button group field and add it to a new page.

View Example

Program.cs

using DevExpress.Pdf;
using System.Drawing;
//...

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.
    radioGroup.AddButton("button1", new RectangleF(0, 0, 20, 20));

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

    // Specify selected index, style and appearance parameters.  
    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);
}

Program.vb

Imports DevExpress.Pdf
Imports System.Drawing
'...
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.
    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 parameters.  
    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