DXMenuItem.Caption Property

Specifies the text displayed within the menu item.

Namespace: DevExpress.Utils.Menu

Assembly: DevExpress.Utils.v24.1.dll

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

Declaration

C#

public string Caption { get; set; }

VB.NET

Public Property Caption As String

Property Value

Type	Description
String	A string that specifies the text displayed within the menu item.

Remarks

The Caption property can contain the ampersand character (‘&’). If the DXMenuItem.ShowHotKeyPrefix is set to true, the character that follows the ampersand is underscored and this indicates that it can be used as a shortcut. At runtime, an end-user can press this character to invoke the menu item’s functionality. For the second menu item in the image below, the Caption property is set to “&Merging Enabled”:

Note

Shortcuts specified this way are only in effect if a popup menu in a control is displayed using the BarManager component. Currently the following controls support popup menus to be displayed using the BarManager:

• EditorContainer descendants (GridControl, TreeList, VGridControl, etc )
• SchedulerControl
• PivotGridControl
• LayoutControl
• BaseEdit descendants (TextEdit, PictureEdit, etc)

To allow popup menus to be displayed using the Bar Manager component, place a BarManager object onto a form, and assign it to the control’s MenuManager property. See the EditorContainer.MenuManager property for more information.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Caption 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-pivot-change-summarydisplaytype-in-context-menu/CS/WindowsApplication34/Form1.cs#L38

DXSubMenuItem sdtItem = new DXSubMenuItem();
sdtItem.Caption = "Summary Display Type";
e.Menu.Items.Add(sdtItem);

winforms-tabbed-mdi-manager-display-custom-header-button/CS/WindowsFormsApplication32/MyTabbedMdiManager/MyTabbedMdiManager.cs#L52

DXMenuItem menuItem = new DXMenuItem();
menuItem.Caption = page.Text;
menuItem.Image = GetMdiTabPageImage(page);

winforms-scheduler-customize-popup-menu/CS/PopupMenuCustomization/Form1.cs#L48

if (item != null) {
    item.Caption = "&New Meeting";
    item.ImageOptions.SvgImage = DevExpress.Utils.Svg.SvgImage.FromFile("NewItem.svg");

how-to-create-and-register-custom-filter-editor-functions/CS/DXApplication5/Main.cs#L50

var menuItem = e.Menu.Find(ClauseType.Between);
menuItem.Caption = "Between A and B";
//menuItem.ImageOptions.SvgImage = MySvgImage1;

VB.NET

winforms-pivot-change-summarydisplaytype-in-context-menu/VB/WindowsApplication34/Form1.vb#L41

Dim sdtItem As New DXSubMenuItem()
sdtItem.Caption = "Summary Display Type"
e.Menu.Items.Add(sdtItem)

winforms-tabbed-mdi-manager-display-custom-header-button/VB/WindowsFormsApplication32/MyTabbedMdiManager/MyTabbedMdiManager.vb#L44

Dim menuItem As DXMenuItem = New DXMenuItem()
menuItem.Caption = page.Text
menuItem.Image = GetMdiTabPageImage(page)

winforms-scheduler-customize-popup-menu/VB/PopupMenuCustomization/Form1.vb#L40

If item IsNot Nothing Then
    item.Caption = "&New Meeting"
    item.ImageOptions.SvgImage = DevExpress.Utils.Svg.SvgImage.FromFile("NewItem.svg")

how-to-create-and-register-custom-filter-editor-functions/VB/DXApplication5/Main.vb#L52

Dim menuItem = e.Menu.Find(ClauseType.Between)
menuItem.Caption = "Between A and B"
'menuItem.ImageOptions.SvgImage = MySvgImage1;