BarAndDockingController.PaintStyleName Property

Gets or sets the name of the paint scheme applied to the Bars UI (BarManager), dock panels (DockManager) and MDI tabbed windows (XtraTabbedMdiManager).

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

[DefaultValue("Default")]
[DXCategory("Appearance")]
public virtual string PaintStyleName { get; set; }

VB.NET

<DefaultValue("Default")>
<DXCategory("Appearance")>
Public Overridable Property PaintStyleName As String

Property Value

Type	Default	Description
String	"Default"	A string specifying the paint scheme name.

Remarks

Use the PaintStyleName property to specify the paint scheme for the Bars UI (BarManager), dock panels (DockManager) and MDI tabbed windows (XtraTabbedMdiManager). The paint scheme affects the overall UI appearance (borders, inner elements and in-place editors).

See the following table for paint scheme examples.

Value	Description	Image
“Default”	The paint scheme is determined by the BarAndDockingController.LookAndFeel object’s settings.
“OfficeXP”	MS Office XP - inspired paint scheme.
“Office2000”	MS Office 2000 - inspired paint scheme.
“WindowsXP”	The paint scheme is dependent on the current Windows OS theme.
“Office2003”	MS Office 2003 - inspired paint scheme.
“Skin”	The skinning paint scheme, specified by UserLookAndFeel.SkinName property, is applied. You can access the UserLookAndFeel.SkinName property to specify the skinning paint scheme in a number of ways: For all controls within all forms in your application - via the DefaultLookAndFeel component or the UserLookAndFeel.Default static object. For all XtraBars controls within all forms in your application - via the DefaultBarAndDockingController component or the BarAndDockingController.Default static object. Note that the BarAndDockingController.LookAndFeel.UseDefaultLookAndFeel property must be set to false for the Default BarAndDockingController‘s settings to be in effect. For all XtraBars controls within a single form - via the BarAndDockingController component. Note that the BarAndDockingController.LookAndFeel.UseDefaultLookAndFeel property must be set to false for the BarAndDockingController‘s settings to be in effect.

If the string assigned to the PaintStyleName property doesn’t match any of the strings listed above, the “Default” string will be assigned instead.

By default, inplace editors embedded in BarEditItem items are painted using the style settings defined by the PaintStyleName property. To change the default behavior, customize the RepositoryItem.LookAndFeel property of the BarEditItem.Edit objects.

Related GitHub Examples

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

how-to-draw-the-dockpanel-tab-header-with-a-custom-color-when-skin-is-used-e3968/CS/Form1.cs#L22

    barAndDockingController1.PaintStyles.Add(new MyPaintStyle(barAndDockingController1.PaintStyles));
    barAndDockingController1.PaintStyleName = "MyPaintStyle";
}

how-to-implement-the-custom-draw-functionality-for-skinned-dock-panels-e2502/CS/E2502/Form1.cs#L22

    barAndDockingController1.PaintStyles.Add(new MyPaintStyle(barAndDockingController1.PaintStyles));
    barAndDockingController1.PaintStyleName = "MyScheme";
}

VB.NET

how-to-draw-the-dockpanel-tab-header-with-a-custom-color-when-skin-is-used-e3968/VB/Form1.vb#L20

    barAndDockingController1.PaintStyles.Add(New MyPaintStyle(barAndDockingController1.PaintStyles))
    barAndDockingController1.PaintStyleName = "MyPaintStyle"
End Sub

how-to-implement-the-custom-draw-functionality-for-skinned-dock-panels-e2502/VB/E2502/Form1.vb#L16

    barAndDockingController1.PaintStyles.Add(New MyPaintStyle(barAndDockingController1.PaintStyles))
    barAndDockingController1.PaintStyleName = "MyScheme"
End Sub