GroupField Class

A form field that organizes other form fields into groups in a PDF document.

Namespace: DevExpress.Docs.Pdf

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

NuGet Package: DevExpress.Docs.Pdf

Declaration

C#

public class GroupField :
    FormField

VB.NET

Public Class GroupField
    Inherits FormField

Related API Members

The following members return GroupField objects:

• FormFieldCollection.FindParent(FormField)

Example

How to: Group Form Fields in 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);

            // Create a font for field labels.
            TextFont textFont = new("Arial", TextFontStyle.Regular);

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

            // Create a label for the first name field.
            TextFragment firstNLabel = new() {
                Text = "First name:",
                Location = new PointF(50, y - textHeight / 2),
                Font = textFont
            };
            page.Fragments.Add(firstNLabel);

            // Create the first name field and bind it to a text widget.
            TextBoxField firstNField = new("FirstName");
            RectangleF firstNBounds = new(120, y - textHeight + 4, 220, textHeight);
            TextBoxWidgetAnnotation firstNWidget = new(firstNField, firstNBounds);
            firstNWidget.FontSize = 12;
            page.Annotations.Add(firstNWidget);
            y -= step;

            // Create a label for the last name field.
            TextFragment lastNLabel = new() {
                Text = "Last name:",
                Location = new PointF(50, y - textHeight / 2),
                Font = textFont
            };
            page.Fragments.Add(lastNLabel);

            // Create the last name field and bind it to a text widget.
            TextBoxField lastNField = new("LastName");
            RectangleF lastNBounds = new(120, y - textHeight + 4, 220, textHeight);
            TextBoxWidgetAnnotation lastNWidget = new(lastNField, lastNBounds);
            lastNWidget.FontSize = 12;
            page.Annotations.Add(lastNWidget);
            y -= step;

            // Create a group field and add both text fields to the group.
            GroupField groupField = new GroupField("Group");
            groupField.Kids.Add(firstNField);
            groupField.Kids.Add(lastNField);
            pdfDocument.Fields.Add(groupField);
        }
    }
}

VB.NET

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

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)

            ' Create a font for field labels.
            Dim textFont As New TextFont("Arial", TextFontStyle.Regular)

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

            ' Create a label for the first name field.
            Dim firstNLabel As New TextFragment() With {
                .Text = "First name:",
                .Location = New PointF(50, y - textHeight / 2),
                .Font = textFont
            }
            page.Fragments.Add(firstNLabel)

            ' Create the first name field and bind it to a text widget.
            Dim firstNField As New TextBoxField("FirstName")
            Dim firstNBounds As New RectangleF(120, y - textHeight + 4, 220, textHeight)
            Dim firstNWidget As New TextBoxWidgetAnnotation(firstNField, firstNBounds)
            firstNWidget.FontSize = 12
            page.Annotations.Add(firstNWidget)
            y -= [step]

            ' Create a label for the last name field.
            Dim lastNLabel As New TextFragment() With {
                .Text = "Last name:",
                .Location = New PointF(50, y - textHeight / 2),
                .Font = textFont
            }
            page.Fragments.Add(lastNLabel)

            ' Create the last name field and bind it to a text widget.
            Dim lastNField As New TextBoxField("LastName")
            Dim lastNBounds As New RectangleF(120, y - textHeight + 4, 220, textHeight)
            Dim lastNWidget As New TextBoxWidgetAnnotation(lastNField, lastNBounds)
            lastNWidget.FontSize = 12
            page.Annotations.Add(lastNWidget)
            y -= [step]

            ' Create a group field and add both text fields to the group.
            Dim groupField As New GroupField("Group")
            groupField.Kids.Add(firstNField)
            groupField.Kids.Add(lastNField)
            pdfDocument.Fields.Add(groupField)
        End Using
    End Function
End Class

End Namespace

Implements

ICloneable

Inheritance

Object

FormField

GroupField