.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

PdfGraphicsAcroFormRadioGroupField Class

A radio group field in PDF Graphics API.

Namespace: DevExpress.Pdf

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

Declaration

public class PdfGraphicsAcroFormRadioGroupField :
    PdfGraphicsAcroFormField

Remarks

Tip

You can use the PdfAcroFormField class to add interactive form fields to a PDF file. Refer to the following article for more information: Interactive Forms in PDF Documents

Create a Form Field

Create a new PdfGraphicsAcroFormRadioGroupField object, and pass a field name and location as constructor parameters. The field location is calculated in the world coordinate system. You can also call the PdfGraphicsAcroFormField.CreateRadioGroup method to crate a radio group field.

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

Specify Form Field Parameters

The following parameters are available:

Parameter API
Selected item SelectedIndex
Radio button style ButtonStyle
Form field name Name
Tooltip text ToolTip
Appearance settings (background and foreground color, font and border options) Appearance

Add a Form Field as a Graphics Content

To add a radio group field as graphics content, pass a PdfGraphicsAcroFormRadioGroupField object as a parameter to the PdfGraphics.AddFormField method. To access PdfGraphics, reference the DevExpress.Pdf.Drawing.v.21.2 assembly.

Draw a Form Field on a Page

To draw an interactive field to a page, call one of the following methods:

Example

This example shows how to use PDF Graphics API to create a radio button group field and add it to a new page.

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

The following code snippets (auto-collected from DevExpress Examples) contain references to the PdfGraphicsAcroFormRadioGroupField class.

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.

Inheritance

Object
PdfGraphicsAcroFormField
PdfGraphicsAcroFormRadioGroupField
See Also