[Expand]General Information
[Expand]WinForms Controls
[Collapse]ASP.NET Controls and MVC Extensions
 [Expand]Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]ASP.NET WebForms Controls
 [Expand]ASP.NET MVC Extensions
 [Expand]Localization
 [Expand]Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Data.Linq
  [Expand]DevExpress.Web
  [Expand]DevExpress.Web.ASPxGauges
  [Expand]DevExpress.Web.ASPxGauges.Base
  [Expand]DevExpress.Web.ASPxGauges.Scripts
  [Expand]DevExpress.Web.ASPxHtmlEditor
  [Expand]DevExpress.Web.ASPxHtmlEditor.Localization
  [Expand]DevExpress.Web.ASPxHtmlEditor.Scripts
  [Expand]DevExpress.Web.ASPxPivotGrid
  [Expand]DevExpress.Web.ASPxPivotGrid.Data
  [Expand]DevExpress.Web.ASPxPivotGrid.HtmlControls
  [Expand]DevExpress.Web.ASPxPivotGrid.Scripts
  [Expand]DevExpress.Web.ASPxRichEdit
  [Expand]DevExpress.Web.ASPxRichEdit.Localization
  [Expand]DevExpress.Web.ASPxRichEdit.Scripts
  [Expand]DevExpress.Web.ASPxScheduler
  [Expand]DevExpress.Web.ASPxScheduler.Commands
  [Expand]DevExpress.Web.ASPxScheduler.Commands.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Controls
  [Expand]DevExpress.Web.ASPxScheduler.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Drawing
  [Expand]DevExpress.Web.ASPxScheduler.Localization
  [Expand]DevExpress.Web.ASPxScheduler.Reporting
  [Expand]DevExpress.Web.ASPxScheduler.Scripts
  [Expand]DevExpress.Web.ASPxSpellChecker
  [Expand]DevExpress.Web.ASPxSpellChecker.Localization
  [Expand]DevExpress.Web.ASPxSpellChecker.Scripts
  [Expand]DevExpress.Web.ASPxSpreadsheet
  [Expand]DevExpress.Web.ASPxSpreadsheet.Localization
  [Expand]DevExpress.Web.ASPxSpreadsheet.Scripts
  [Expand]DevExpress.Web.ASPxTreeList
  [Expand]DevExpress.Web.ASPxTreeList.Internal
  [Expand]DevExpress.Web.ASPxTreeList.Localization
  [Collapse]DevExpress.Web.ASPxTreeList.Scripts
   [Collapse]ASPxClientTreeList Class
     ASPxClientTreeList Members
     ASPxClientTreeList Constructor
    [Expand]ASPxClientTreeList Properties
    [Collapse]ASPxClientTreeList Events
      BatchEditChangesCanceling Event
      BatchEditChangesSaving Event
      BatchEditConfirmShowing Event
      BatchEditEndEditing Event
      BatchEditNodeDeleting Event
      BatchEditNodeInserting Event
      BatchEditNodeValidating Event
      BatchEditStartEditing Event
      BatchEditTemplateCellFocused Event
      BeginCallback Event
      CallbackError Event
      ColumnResized Event
      ColumnResizing Event
      ContextMenu Event
      CustomButtonClick Event
      CustomDataCallback Event
      CustomizationWindowCloseUp Event
      EndCallback Event
      EndDragNode Event
      FocusedCellChanging Event
      FocusedNodeChanged Event
      NodeClick Event
      NodeCollapsing Event
      NodeDblClick Event
      NodeExpanding Event
      NodeFocusing Event
      SelectionChanged Event
      StartDragNode Event
      ToolbarItemClick Event
    [Expand]ASPxClientTreeList Methods
   [Expand]ASPxClientTreeListBatchEditApi Class
   [Expand]ASPxClientTreeListBatchEditChangesCancelingEventArgs Class
    ASPxClientTreeListBatchEditChangesCancelingEventHandler Delegate
   [Expand]ASPxClientTreeListBatchEditChangesSavingEventArgs Class
    ASPxClientTreeListBatchEditChangesSavingEventHandler Delegate
   [Expand]ASPxClientTreeListBatchEditConfirmShowingEventArgs Class
    ASPxClientTreeListBatchEditConfirmShowingEventHandler Delegate
   [Expand]ASPxClientTreeListBatchEditEndEditingEventArgs Class
    ASPxClientTreeListBatchEditEndEditingEventHandler Delegate
   [Expand]ASPxClientTreeListBatchEditNodeDeletingEventArgs Class
    ASPxClientTreeListBatchEditNodeDeletingEventHandler Delegate
   [Expand]ASPxClientTreeListBatchEditNodeInsertingEventArgs Class
    ASPxClientTreeListBatchEditNodeInsertingEventHandler Delegate
   [Expand]ASPxClientTreeListBatchEditNodeValidatingEventArgs Class
    ASPxClientTreeListBatchEditNodeValidatingEventHandler Delegate
   [Expand]ASPxClientTreeListBatchEditStartEditingEventArgs Class
    ASPxClientTreeListBatchEditStartEditingEventHandler Delegate
   [Expand]ASPxClientTreeListBatchEditTemplateCellFocusedEventArgs Class
    ASPxClientTreeListBatchEditTemplateCellFocusedEventHandler Delegate
   [Expand]ASPxClientTreeListCellInfo Class
   [Expand]ASPxClientTreeListColumn Class
   [Expand]ASPxClientTreeListColumnResizedEventArgs Class
    ASPxClientTreeListColumnResizedEventHandler Delegate
   [Expand]ASPxClientTreeListColumnResizingEventArgs Class
    ASPxClientTreeListColumnResizingEventHandler Delegate
   [Expand]ASPxClientTreeListContextMenuEventArgs Class
    ASPxClientTreeListContextMenuEventHandler Delegate
   [Expand]ASPxClientTreeListCustomButtonEventArgs Class
    ASPxClientTreeListCustomButtonEventHandler Delegate
   [Expand]ASPxClientTreeListCustomDataCallbackEventArgs Class
    ASPxClientTreeListCustomDataCallbackEventHandler Delegate
   [Expand]ASPxClientTreeListEndDragNodeEventArgs Class
    ASPxClientTreeListEndDragNodeEventHandler Delegate
   [Expand]ASPxClientTreeListExportFormat Class
   [Expand]ASPxClientTreeListFocusedCellChangingEventArgs Class
    ASPxClientTreeListFocusedCellChangingEventHandler Delegate
   [Expand]ASPxClientTreeListNodeEventArgs Class
    ASPxClientTreeListNodeEventHandler Delegate
   [Expand]ASPxClientTreeListStartDragNodeEventArgs Class
    ASPxClientTreeListStartDragNodeEventHandler Delegate
   [Expand]ASPxClientTreeListToolbarItemClickEventArgs Class
    ASPxClientTreeListToolbarItemClickEventHandler Delegate
    ASPxClientTreeListValuesCallback Delegate
  [Expand]DevExpress.Web.Captcha
  [Expand]DevExpress.Web.Data
  [Expand]DevExpress.Web.Internal
  [Expand]DevExpress.Web.Localization
  [Expand]DevExpress.Web.Mvc
  [Expand]DevExpress.Web.Mvc.BinderSettings
  [Expand]DevExpress.Web.Mvc.Controllers
  [Expand]DevExpress.Web.MVC.Scripts
  [Expand]DevExpress.Web.Mvc.UI
  [Expand]DevExpress.Web.Office
  [Expand]DevExpress.Web.Office.Internal
  [Expand]DevExpress.Web.Rendering
  [Expand]DevExpress.Web.Scripts
  [Expand]DevExpress.XtraCharts.Web
  [Expand]DevExpress.XtraCharts.Web.Designer
  [Expand]DevExpress.XtraCharts.Web.Scripts
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

ASPxClientTreeList.ContextMenu Event

Enables you to display a context menu.

Namespace:DevExpress.Web.ASPxTreeList.Scripts
Assembly:JavaScript

Expanded Syntax

Expanded Event Data

The event handler receives an argument of type ASPxClientTreeListContextMenuEventArgs containing data related to this event.

The following ASPxClientTreeListContextMenuEventArgs properties provide information specific to this event.
Property Description
cancel Gets or sets whether to invoke the browser's context menu.
htmlEvent Gets a DHTML event object that relates to the processed event.
objectKey Gets a value that identifies the right-clicked object.
objectType Identifies which tree list element has been right-clicked.

Expanded Remarks

The ContextMenu event is raised when an end-user has right-clicked within an ASPxTreeList, and enables you to invoke a context menu. The event parameter provides the following properties:

  • objectType

    Identifies which tree list element ('Header' or 'Node') has been right-clicked.
  • objectKey

    Returns a key value that identifies the clicked node. If a column header has been right-clicked, this property returns the column's index.
  • htmlEvent

    Gets a DHTML event object that relates to the processed event.
  • cancel

    Specifies whether to invoke the browser's context menu.

Expanded Example

This example demonstrates how to display a context menu. When an end-user right-clicks within the ASPxTreeList, the client-side ContextMenu event is fired. In this example, the context menu is invoked when a node is right-clicked.

The image below shows the result:

Expanded See Also

Is this topic helpful?​​​​​​​