PdfGraphicsAcroFormFieldAppearance.BackgroundColor Property

Specifies the form field’s background color.

Namespace: DevExpress.Pdf

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

NuGet Package: DevExpress.Pdf.Drawing

Declaration

C#

public Color BackgroundColor { get; set; }

VB.NET

Public Property BackgroundColor As Color

Property Value

Type	Description
Color	A Color value that specifies the interactive form field’s background color.

Example

This example shows how to use 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

Related GitHub Examples

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

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-combo-box-field/CS/AddComboBoxField/Program.cs#L37

comboBox.TextAlignment = PdfAcroFormStringAlignment.Far;
comboBox.Appearance.BackgroundColor = Color.Beige;
comboBox.Appearance.FontSize = 14;

pdf-document-api-create-check-box-field/CS/AddCheckBoxField/Program.cs#L28

// Specify check box appearance, checked state, and button style.
checkBox.Appearance.BackgroundColor = Color.Azure;
checkBox.Appearance.BorderAppearance = new PdfGraphicsAcroFormBorderAppearance() { Color = Color.Red };

pdf-document-api-create-list-box-field/CS/AddListBoxField/Program.cs#L35

// Specify list box appearance, text alignment, and select value.
listBox.Appearance.BackgroundColor = Color.Aqua;
listBox.TextAlignment = PdfAcroFormStringAlignment.Far;

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

radioGroup.ButtonStyle = PdfAcroFormButtonStyle.Circle;
radioGroup.Appearance.BackgroundColor = Color.Aqua;
radioGroup.Appearance.BorderAppearance = new PdfGraphicsAcroFormBorderAppearance() { Color = Color.Red, Width = 3 };

pdf-document-api-create-interactive-form/CS/AddFormFieldsToNewDocument/Program.cs#L30

textBox.Appearance.FontSize = 12;
textBox.Appearance.BackgroundColor = Color.AliceBlue;

VB.NET

pdf-document-api-create-combo-box-field/VB/AddComboBoxField/Program.vb#L32

comboBox.TextAlignment = PdfAcroFormStringAlignment.Far
comboBox.Appearance.BackgroundColor = Color.Beige
comboBox.Appearance.FontSize = 14

pdf-document-api-create-check-box-field/VB/AddCheckBoxField/Program.vb#L25

' Specify check box appearance, checked state, and button style.
checkBox.Appearance.BackgroundColor = Color.Azure
checkBox.Appearance.BorderAppearance = New PdfGraphicsAcroFormBorderAppearance() With {.Color = Color.Red}

pdf-document-api-create-list-box-field/VB/AddListBoxField/Program.vb#L30

' Specify list box appearance, text alignment, and select value.
listBox.Appearance.BackgroundColor = Color.Aqua
listBox.TextAlignment = PdfAcroFormStringAlignment.Far

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

radioGroup.ButtonStyle = PdfAcroFormButtonStyle.Circle
radioGroup.Appearance.BackgroundColor = Color.Aqua
radioGroup.Appearance.BorderAppearance = New PdfGraphicsAcroFormBorderAppearance() With {.Color = Color.Red, .Width = 3}

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

textBox.Appearance.FontSize = 12
textBox.Appearance.BackgroundColor = Color.AliceBlue
' Add the text box field to graphics.