XRControl.BackColor Property

Gets or sets the control’s background color.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

[SRCategory(ReportStringId.CatAppearance)]
public virtual Color BackColor { get; set; }

VB.NET

<SRCategory(ReportStringId.CatAppearance)>
Public Overridable Property BackColor As Color

Property Value

Type	Description
Color	A Color object that represents the background color. The default value is Transparent.

Remarks

The BackColor property specifies the control’s background color, while the control’s foreground color is specified by its XRControl.ForeColor property.

If the BackColor property’s value is not set for the current report control, its value is obtained from its parent, or a parent of its parent and so on. Similarly, the BackColor value of the current control is applied to all its child report controls (if there are any in its XRControl.Controls collection), if their BackColor property value is not set. For more information on this concept, please refer to Appearance Properties.

Note

The BackColor property is not used by all descendants of the XRControl class. For example, the XRPageBreak class ignores the BackColor property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BackColor 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#

Reporting_how-to-create-a-label-in-the-pageheader-band-when-a-field-is-dragged-from-the-t457241/CS/T457241/Form1.cs#L98

newLabel.HeightF = label.HeightF;
newLabel.BackColor = Color.Green;
newLabel.ForeColor = Color.Yellow;

Reporting_how-to-change-a-labels-appearance-in-its-beforeprint-event-handler-e928/CS/XtraReport1.cs#L21

    label.ForeColor = Color.White;
    label.BackColor = Color.Red;
}

Reporting_how-to-customize-a-report-controls-appearance-only-when-exporting-the-report-e1159/CS/WindowsApplication1/XtraReport1.cs#L21

if (isExporting)
    cell.BackColor = Color.Green;
else

Reporting_how-to-bind-a-report-to-a-list-t-data-source-e3425/CS/Form1.cs#L55

label.DataBindings.Add(new XRBinding("Text", null, dataMember));
label.BackColor = backColor;
label.Location = new Point(offset, 0);

Reporting_runtime-detail-height-sizing-with-respect-to-xrsubreport-size-e20055/CS/dx_sample/XtraReport1.cs#L31

if (labelBrick != null && labelBrick.Value != null && labelBrick.Value.ToString() != string.Empty) {
    ((XRLabel)labelBrick.BrickOwner.RealControl).BackColor = Color.LightGreen;
    if (sections.ContainsKey(labelBrick.Value.ToString()))

VB.NET

Reporting_how-to-create-a-label-in-the-pageheader-band-when-a-field-is-dragged-from-the-t457241/VB/T457241/Form1.vb#L107

newLabel.HeightF = label.HeightF
newLabel.BackColor = Color.Green
newLabel.ForeColor = Color.Yellow

Reporting_how-to-change-a-labels-appearance-in-its-beforeprint-event-handler-e928/VB/XtraReport1.vb#L23

    label.ForeColor = Color.White
    label.BackColor = Color.Red
ElseIf total > 1000 Then

Reporting_how-to-customize-a-report-controls-appearance-only-when-exporting-the-report-e1159/VB/WindowsApplication1/XtraReport1.vb#L23

If isExporting Then
    cell.BackColor = Color.Green
Else

Reporting_how-to-bind-a-report-to-a-list-t-data-source-e3425/VB/Form1.vb#L57

label.DataBindings.Add(New XRBinding("Text", Nothing, dataMember))
label.BackColor = backColor
label.Location = New Point(offset, 0)

Reporting_runtime-detail-height-sizing-with-respect-to-xrsubreport-size-e20055/VB/dx_sample/XtraReport1.vb#L35

If labelBrick IsNot Nothing AndAlso labelBrick.Value IsNot Nothing AndAlso labelBrick.Value.ToString() <> String.Empty Then
    CType(labelBrick.BrickOwner.RealControl, XRLabel).BackColor = Color.LightGreen
    If sections.ContainsKey(labelBrick.Value.ToString()) Then