officefileapi-devexpress-dot-pdf-ba59b269.md
A radio group field in PDF Graphics API.
Namespace : DevExpress.Pdf
Assembly : DevExpress.Pdf.v25.2.Drawing.dll
NuGet Package : DevExpress.Pdf.Drawing
public class PdfGraphicsAcroFormRadioGroupField :
PdfGraphicsAcroFormField
Public Class PdfGraphicsAcroFormRadioGroupField
Inherits PdfGraphicsAcroFormField
The following members return PdfGraphicsAcroFormRadioGroupField objects:
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 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.
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 |
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.25.2 assembly.
To draw an interactive field to a page, call one of the following methods:
The following code snippet uses 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.CreateGraphicsPageSystem())
{
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);
}
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.CreateGraphicsPageSystem()
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
Object PdfGraphicsAcroFormField PdfGraphicsAcroFormRadioGroupField
See Also