Bar

BarItem.Description Property

Specifies the bar item's description.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

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

Property Value

Type Description
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:

    Description of BarItem

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

    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