AppearanceObject.BackColor Property

Gets or sets the background color if the AppearanceObject.BackColor2 property’s value is Color.Empty. Otherwise, it specifies the gradient’s starting color.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v23.2.dll

NuGet Packages: DevExpress.Utils, DevExpress.Wpf.Core

Declaration

C#

[XtraSerializableProperty]
[DXCategory("Appearance")]
public Color BackColor { get; set; }

VB.NET

<XtraSerializableProperty>
<DXCategory("Appearance")>
Public Property BackColor As Color

Property Value

Type	Description
Color	A Color object specifying the background color.

Remarks

The BackColor property specifies the background color if the AppearanceObject.BackColor2 property value is Color.Empty. Otherwise, it specifies the gradient’s starting color.

If the AppearanceOptions.UseBackColor property is set to false and the appearance object has a parent, the parent’s background color is used. Use the AppearanceObject.GetBackColor method to obtain the background color specified by the appearance object’s settings.

When an AppearanceObject’s style setting (for example, BackColor, ForeColor, Font and TextOptions.HAlignment) is set to a non-default value, the corresponding Options.Use… option (for instance, Options.UseBackColor, Options.UseForeColor, Options.UseFont and Options.UseTextOptions) is automatically set to true in the following cases:

• The AppearanceObject belongs to a control/component (or its element), and this control/component has been completely loaded (see the control’s IsLoading property to check the load status);
• The AppearanceObject belongs to a grid column/band or tree list column/band, and the column/band belongs to a grid/tree list control;
• The AppearanceObject is standalone, that is, it does not belong to any control or component.

In other cases, the Options.Use… options are not automatically enabled. You may need to enable these options manually for the style settings to be in effect.

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#

winforms-grid-print-export-custom-painted-content/CS/MyXtraGrid/Form1.cs#L46

e.Handled = true;
e.Appearance.BackColor = Color.Yellow;
e.Appearance.FillRectangle(e.Cache, e.Bounds);

winforms-scheduler-country-specific-work-week-holidays/CS/Form1.cs#L110

cell.Appearance.ForeColor = Color.DarkGoldenrod;
cell.Appearance.BackColor = Color.PaleGreen;
break;

winforms-calendar-dateedit-cell-appearance-customization/CS/Calendar_CellStyleProvider/Form1.cs#L71

if (cell.Active)
    cell.Appearance.BackColor = Color.HotPink;
else

winforms-docking-custom-draw-skinned-dock-panel-caption/CS/E2502/Form1.cs#L38

AppearanceObject appearance = new AppearanceObject();
appearance.BackColor = e.Panel == myDockPanel1 ? Color.Yellow : Color.LightCyan;
appearance.BackColor2 = e.Panel == myDockPanel1 ? Color.Orange: Color.SkyBlue;

winforms-grid-hide-vertical-lines-between-certain-columns/CS/E3647/ColumnLineHelper.cs#L51

GridViewInfo vi = view.GetViewInfo() as GridViewInfo;
Pen standardPen = e.Cache.GetPen(view.PaintAppearance.Row.BackColor);
Pen pen;

VB.NET

winforms-grid-print-export-custom-painted-content/VB/MyXtraGrid/Form1.vb#L46

e.Handled = True
e.Appearance.BackColor = Color.Yellow
e.Appearance.FillRectangle(e.Cache, e.Bounds)

winforms-scheduler-country-specific-work-week-holidays/VB/Form1.vb#L101

    cell.Appearance.ForeColor = Color.DarkGoldenrod
    cell.Appearance.BackColor = Color.PaleGreen
' Highlight selection.

winforms-calendar-dateedit-cell-appearance-customization/VB/Calendar_CellStyleProvider/Form1.vb#L86

If cell.Active Then
    cell.Appearance.BackColor = Color.HotPink
Else

winforms-docking-custom-draw-skinned-dock-panel-caption/VB/E2502/Form1.vb#L29

Dim appearance As AppearanceObject = New AppearanceObject()
appearance.BackColor = If(e.Panel Is myDockPanel1, Color.Yellow, Color.LightCyan)
appearance.BackColor2 = If(e.Panel Is myDockPanel1, Color.Orange, Color.SkyBlue)

winforms-grid-hide-vertical-lines-between-certain-columns/VB/E3647/ColumnLineHelper.vb#L51

Dim vi As GridViewInfo = TryCast(view.GetViewInfo(), GridViewInfo)
Dim standardPen As Pen = e.Cache.GetPen(view.PaintAppearance.Row.BackColor)
Dim pen As Pen