AppearanceObject.BorderColor Property

Gets or sets the border color.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v23.2.dll

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

Declaration

C#

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

VB.NET

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

Property Value

Type	Description
Color	A Color object specifying the border color.

Remarks

Setting the BorderColor property to Color.Empty automatically sets the appearance object’s AppearanceOptions.UseBorderColor property to false. If this property is set to false and the current appearance has a parent, the parent’s border color is used.

The code below shows how to set a custom border color for a button.

C#

simpleButton1.BorderStyle = DevExpress.XtraEditors.Controls.BorderStyles.Office2003;
simpleButton1.Appearance.BorderColor = Color.Red;
simpleButton1.Appearance.Options.UseBorderColor = true;

VB.NET

simpleButton1.BorderStyle = DevExpress.XtraEditors.Controls.BorderStyles.Office2003
simpleButton1.Appearance.BorderColor = Color.Red
simpleButton1.Appearance.Options.UseBorderColor = True

Use the AppearanceObject.GetBorderColor method to obtain the border 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 BorderColor 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/MyGridView/MyGridViewPrintInfo.cs#L69

BorderSide border = args.Appearance.Options.UseBorderColor ? BorderSide.All : BorderSide.None;
ib = new ImageBrick(border, 1, args.Appearance.BorderColor, args.Appearance.BackColor);
ib.Rect = rect;

winforms-grid-custom-print-cells-headers-in-print-preview/CS/GridBeforePrint/MyGridViewPrintInfo.cs#L31

    AppearanceHelper.Combine(temp, new AppearanceObject[] { col.Column.AppearanceHeader, View.Appearance.HeaderPanel, AppearancePrint.HeaderPanel });
    SetDefaultBrickStyle(graph, Bricks.Create(temp, BorderSide.All, temp.BorderColor, 1));
}

winforms-grid-print-custom-draw-content/CS/MyXtraGrid/MyGridView/MyGridViewPrintInfo.cs#L58

BorderSide border = args.Appearance.Options.UseBorderColor? BorderSide.All: BorderSide.None;
ImageBrick ib = new ImageBrick(border, 1, args.Appearance.BorderColor, args.Appearance.BackColor);
ib.Rect = rect;

VB.NET

winforms-grid-print-export-custom-painted-content/VB/MyXtraGrid/MyGridView/MyGridViewPrintInfo.vb#L65

Dim border As BorderSide = If(args.Appearance.Options.UseBorderColor, BorderSide.All, BorderSide.None)
ib = New ImageBrick(border, 1, args.Appearance.BorderColor, args.Appearance.BackColor)
ib.Rect = rect

winforms-grid-custom-print-cells-headers-in-print-preview/VB/GridBeforePrint/MyGridViewPrintInfo.vb#L32

    AppearanceHelper.Combine(temp, New AppearanceObject() {col.Column.AppearanceHeader, View.Appearance.HeaderPanel, AppearancePrint.HeaderPanel})
    SetDefaultBrickStyle(graph, Bricks.Create(temp, BorderSide.All, temp.BorderColor, 1))
End If

winforms-grid-print-custom-draw-content/VB/MyXtraGrid/MyGridView/MyGridViewPrintInfo.vb#L59

Dim border As BorderSide = If(args.Appearance.Options.UseBorderColor, BorderSide.All, BorderSide.None)
Dim ib As New ImageBrick(border, 1, args.Appearance.BorderColor, args.Appearance.BackColor)
ib.Rect = rect