DXMenuItem.Caption Property

Specifies the text displayed within the menu item.

Namespace: DevExpress.Utils.Menu

Assembly: DevExpress.Utils.v19.2.dll

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#

how-to-display-multiply-summaries-in-the-same-column-e2217/CS/MyXtraGrid/Form1.cs#L43

DXSubMenuItem subItem = new DXSubMenuItem();
subItem.Caption = "Item 2";
DXMenuItem myItem = new DXMenuItem("Now!");

winforms-pivot-change-summarydisplaytype-in-context-menu/CS/WindowsApplication34/Form1.cs#L37

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

invoke-summary-type-menu-when-user-hovers-over-the-field-header-with-a-mouse-e2351/CS/WindowsApplication34/Form1.cs#L49

{
    if (!necessaryItems.Contains(e.Menu.Items[i].Caption))
        e.Menu.Items.RemoveAt(i);

how-to-print-or-export-a-map-t185956/CS/MapControl_PrintingExporting/Form1.cs#L84

DXMenuItem item = sender as DXMenuItem;
ddbPrint.Text = printButtonTextBase + item.Caption;
printType = (PrintType)printHashtable[item];

how-to-replace-standard-menus-with-my-own-e2788/CS/WindowsApplication1/Custom menu/DXMenuItemWrapper.cs#L24

{
    return _Item.Caption;
}

VB.NET

how-to-display-multiply-summaries-in-the-same-column-e2217/VB/MyXtraGrid/Form1.vb#L47

Dim subItem As New DXSubMenuItem()
subItem.Caption = "Item 2"
Dim myItem As New DXMenuItem("Now!")

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

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

invoke-summary-type-menu-when-user-hovers-over-the-field-header-with-a-mouse-e2351/VB/WindowsApplication34/Form1.vb#L44

Do While i < e.Menu.Items.Count
    If (Not necessaryItems.Contains(e.Menu.Items(i).Caption)) Then
        e.Menu.Items.RemoveAt(i)

how-to-print-or-export-a-map-t185956/VB/MapControl_PrintingExporting/Form1.vb#L90

Dim item As DXMenuItem = TryCast(sender, DXMenuItem)
ddbPrint.Text = printButtonTextBase & item.Caption
printType = DirectCast(printHashtable(item), PrintType)

how-to-replace-standard-menus-with-my-own-e2788/VB/Custom menu/DXMenuItemWrapper.vb#L21

Public Overrides Function ToString() As String
    Return _Item.Caption
End Function