Back to Devexpress

BarItem.Description Property

windowsforms-devexpress-dot-xtrabars-dot-baritem-f28549d3.md

latest2.5 KB
Original Source

BarItem.Description Property

Specifies the bar item’s description.

Namespace : DevExpress.XtraBars

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[DXCategory("Appearance")]
public virtual string Description { get; set; }
vb
<DXCategory("Appearance")>
Public Overridable Property Description As String

Property Value

TypeDescription
String

A string that specifies the bar item’s description.

|

Remarks

The item’s description is displayed in the following instances:

  • when the item is selected within the “Commands” tab in the Customization Form:

  • when the item is displayed within a submenu or popup menu which has the MenuDrawMode property set to MenuDrawMode.LargeImagesTextDescription:

You have the ability to format the Description using HTML tags. To enable this feature for all bar items within a BarManager or RibbonControl, use the BarManager.AllowHtmlText and RibbonControl.AllowHtmlText property, respectively. To enable this feature for individual bar items, use the BarItem.AllowHtmlText property.

See Also

Caption

BarCustomContainerItem.MenuDrawMode

PopupMenuBase.MenuDrawMode

ItemDescription

ItemDescriptionDisabled

BarItem Class

BarItem Members

DevExpress.XtraBars Namespace