AppearanceOptions.UseBackColor Property

Gets or sets whether to use the AppearanceObject.BackColor property value.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v24.2.dll

Declaration

C#

[DefaultValue(false)]
[DXCategory("Appearance")]
[XtraSerializableProperty]
public virtual bool UseBackColor { get; set; }

VB.NET

<DefaultValue(False)>
<XtraSerializableProperty>
<DXCategory("Appearance")>
Public Overridable Property UseBackColor As Boolean

Property Value

Type	Default	Description
Boolean	false	true to use the AppearanceObject.BackColor property value; false to use the background color specified by the parent appearance object.

Property Paths

You can access this nested property as listed below:

Object Type	Path to UseBackColor
AppearanceObject	.Options .UseBackColor
AppearanceOptions	.Empty .UseBackColor

Remarks

If the current appearance object has no parent, the AppearanceObject.BackColor property value is used regardless of the UseBackColor property setting. Please refer to the Look and Feel topic for details.

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 UseBackColor 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-save-restore-splitter-position/CS/UserControl1.cs#L73

this.splitContainerControl1.Panel1.Appearance.BackColor = System.Drawing.Color.Lime;
this.splitContainerControl1.Panel1.Appearance.Options.UseBackColor = true;
this.splitContainerControl1.Panel1.Text = "splitContainerControl1_Panel1";

winforms-grid-copy-cells-in-biff8-format-using-excel-export-api/CS/gridCopyToClipboardExample/CopyToClipboardHelper.cs#L85

// Apply fill
if (appearance.Options.UseBackColor)
    cell.ApplyFormatting(XlFill.SolidFill(appearance.BackColor));

VB.NET

winforms-save-restore-splitter-position/VB/UserControl1.vb#L73

splitContainerControl1.Panel1.Appearance.BackColor = System.Drawing.Color.Lime
splitContainerControl1.Panel1.Appearance.Options.UseBackColor = True
splitContainerControl1.Panel1.Text = "splitContainerControl1_Panel1"

winforms-grid-copy-cells-in-biff8-format-using-excel-export-api/VB/gridCopyToClipboardExample/CopyToClipboardHelper.vb#L78

' Apply fill
If appearance.Options.UseBackColor Then cell.ApplyFormatting(XlFill.SolidFill(appearance.BackColor))
' Apply font