GridViewContextMenuItemCollection.Add(String, String) Method

Adds a new item with the specified settings to the end of the collection and returns the newly created object.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.2.dll

Declaration

C#

public GridViewContextMenuItem Add(
    string text,
    string name
)

VB.NET

Public Function Add(
    text As String,
    name As String
) As GridViewContextMenuItem

Parameters

Name	Type	Description
text	String	A String value that specifies the item text. Initializes the item’s MenuItem.Text property.
name	String	A String value that specifies the created item’s name. Initializes the item’s MenuItem.Name property.

Returns

Type	Description
GridViewContextMenuItem	A GridViewContextMenuItem object that is the newly created item.

Remarks

Use the Add method to add a new item with the specified settings to the GridViewContextMenuItemCollection object.

Example

The code sample below demonstrates how to provide the default grid context menu with two custom items. To add the items to the item collection, the ASPxGridView.FillContextMenuItems event is used. On the client-side, the ASPxClientGridView.ContextMenuItemClick event is handled to respond to a custom item click.

The image below demonstrates a context menu with the custom items.

ASPX

<dx:ASPxGridView ID="MyGridView" runat="server" AutoGenerateColumns="False" DataSourceID="AccessDataSource" ClientInstanceName="myGrid" KeyFieldName="ProductID" OnFillContextMenuItems="MyGridView_FillContextMenuItems">
     <ClientSideEvents ContextMenuItemClick="function(s, e) {
          switch(e.item.name) { 
               case 'SelectAll':
                    myGrid.SelectRows();
                    break;
               case 'DeselectAll':
                    myGrid.UnselectRows();
                    break;
          }
     }" />
     <Columns>
          ...
     </Columns>
     <SettingsBehavior AllowSelectByRowClick="True" />
     <SettingsContextMenu Enabled="True">
     </SettingsContextMenu>
</dx:ASPxGridView>

C#

protected void MyGridView_FillContextMenuItems(object sender, ASPxGridViewContextMenuEventArgs e) {
     e.Items.Add("Select All", "SelectAll");
     e.Items.Add("Deselect All", "DeselectAll");
}

VB.NET

Protected Sub MyGridView_FillContextMenuItems(ByVal sender As Object, ByVal e As ASPxGridViewContextMenuEventArgs)
     e.Items.Add("Select All", "SelectAll")
     e.Items.Add("Deselect All", "DeselectAll")
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Add(String, String) method.

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#

gridview-how-to-implement-export-from-an-embedded-context-menu-t150435/CS/Controllers/HomeController.cs#L55

private static void AddMenuSubItem(GridViewContextMenuItem parentItem, string text, string name, string imageUrl, bool isPostBack) {
    var exportToXlsItem = parentItem.Items.Add(text, name);
    exportToXlsItem.Image.Url = imageUrl;

VB.NET

gridview-how-to-implement-export-from-an-embedded-context-menu-t150435/VB/Controllers/HomeController.vb#L63

Private Shared Sub AddMenuSubItem(ByVal parentItem As GridViewContextMenuItem, ByVal text As String, ByVal name As String, ByVal imageUrl As String, ByVal isPostBack As Boolean)
    Dim exportToXlsItem = parentItem.Items.Add(text, name)
    exportToXlsItem.Image.Url = imageUrl