Back to Devexpress

DxTreeList.CustomizeContextMenu Event

blazor-devexpress-dot-blazor-dot-dxtreelist-f0634f39.md

latest18.5 KB
Original Source

DxTreeList.CustomizeContextMenu Event

Allows you to customize context menus.

Namespace : DevExpress.Blazor

Assembly : DevExpress.Blazor.v25.2.dll

NuGet Package : DevExpress.Blazor

Declaration

csharp
[Parameter]
public Action<TreeListCustomizeContextMenuEventArgs> CustomizeContextMenu { get; set; }

Parameters

TypeDescription
TreeListCustomizeContextMenuEventArgs

An object that contains data for this event.

|

Remarks

The DevExpress Blazor TreeList allows you to display context menus with predefined and custom commands. Use the ContextMenus property to activate context menus for specific TreeList elements. Handle the CustomizeContextMenu event to modify the menu item collection.

Run Demo: Context Menu

Identify Target Cells

Use the Context event argument to identify the target TreeList element and obtain contextual information.

Target ElementContext TypeContextual information
AnyITreeListCommandContextTreeList
Data RowTreeListDataRowCommandContextTreeList, Column, DataItem, RowVisibleIndex
FooterTreeListFooterCommandContextTreeList, Column, SummaryItems
HeaderTreeListHeaderCommandContextTreeList, Column

The following code snippet customizes commands available in header and data row context menus:

razor
@inject EmployeeTaskService EmployeeTaskService

<DxTreeList Data="TreeListData" 
            KeyFieldName="Id" 
            ParentKeyFieldName="ParentId"
            ContextMenus="@(TreeListContextMenus.Header | TreeListContextMenus.DataRow)"
            CustomizeContextMenu="CustomizeContextMenu">
    <Columns>
        <DxTreeListSelectionColumn Width="80px"/>
        <DxTreeListDataColumn FieldName="Name" Caption="Task" />
        <DxTreeListDataColumn FieldName="EmployeeName" />
        <DxTreeListDataColumn FieldName="StartDate" />
        <DxTreeListDataColumn FieldName="DueDate" />
    </Columns>
</DxTreeList>

@code {
    List<EmployeeTask> TreeListData { get; set; }

    protected override void OnInitialized() {
        TreeListData = EmployeeTaskService.GenerateData();
    }
    void CustomizeContextMenu(TreeListCustomizeContextMenuEventArgs args) {
        // Customizes context menu commands for the selection column header
        if (args.Context is TreeListHeaderCommandContext headerContext) {    
            if (headerContext.Column is ITreeListSelectionColumn selectionColumn) {
                var isFixed = selectionColumn.FixedPosition != TreeListColumnFixedPosition.None;
                string itemText = isFixed ? "Unfix Column" : "Fix Column to the Left";
                var newValue = isFixed ? TreeListColumnFixedPosition.None : TreeListColumnFixedPosition.Left;
                args.Items.AddCustomItem(itemText, () => {
                    headerContext.TreeList.BeginUpdate();
                    headerContext.Column.FixedPosition = newValue;
                    headerContext.TreeList.EndUpdate();
                });
            }
        }
        // Adds context menu commands for data rows
        if (args.Context is TreeListDataRowCommandContext) {
            args.Items.Add(TreeListContextMenuDefaultItemNames.ExpandAll);
            args.Items.Add(TreeListContextMenuDefaultItemNames.CollapseAll);
        }
    }
}
csharp
public class EmployeeTask {
    public int Id { get; set; }
    public int ParentId { get; set; }
    public string Name { get; set; }
    public string EmployeeName { get; set; }
    public DateTime StartDate { get; set; }
    public DateTime DueDate { get; set; }
    public int Progress { get; set; }
    public EmployeeTask() { }
    public EmployeeTask(
        int id,
        int parentId,
        string name,
        string employeeName,
        DateTime startDate,
        DateTime dueDate,
        int progress
        )
    {
        Id = id;
        ParentId = parentId;
        Name = name;
        EmployeeName = employeeName;
        StartDate = startDate;
        DueDate = dueDate;
        Progress = progress;
    }
}
csharp
public class EmployeeTaskService {
    public List<EmployeeTask> GenerateData() {
        return new List<EmployeeTask>() {
            new EmployeeTask(1, 0, "Simplify & Clarify Product Messaging", "John Heart", new DateTime(2018, 4, 3), new DateTime(2018, 4, 14), 14),
            new EmployeeTask(2, 1, "Prepare Financial Reports", "Samantha Bright", new DateTime(2018, 4, 3), new DateTime(2018, 4, 7), 17),
            new EmployeeTask(3, 1, "Prepare Marketing Plan", "Arthur Miller", new DateTime(2018, 4, 7), new DateTime(2018, 4, 14), 11),
            new EmployeeTask(4, 0, "Create Action Plan to Improve Customer Engagement", "Robert Reagan", new DateTime(2017, 8, 8), new DateTime(2018, 4, 8), 23),
            new EmployeeTask(5, 4, "Update Personnel Files", "Greta Sims", new DateTime(2017, 8, 8), new DateTime(2017, 10, 18), 100),
            new EmployeeTask(6, 4, "Review Health Insurance Options", "Brett Wade", new DateTime(2017, 9, 27), new DateTime(2017, 11, 10), 37),
            new EmployeeTask(7, 4, "Choose Between PPO and HMO Health Plan", "Sandra Johnson", new DateTime(2017, 12, 13), new DateTime(2018, 3, 23), 17),
            new EmployeeTask(8, 4, "Update Google Adwords Strategy", "Ed Holmes", new DateTime(2017, 8, 23), new DateTime(2017, 12, 23), 45),
            new EmployeeTask(9, 4, "Create New Brochure Design", "Barb Banks", new DateTime(2018, 1, 3), new DateTime(2018, 3, 14), 17),
            new EmployeeTask(10, 4, "Obtain Price Quote for New Brochure", "Kevin Carter", new DateTime(2018, 2, 1), new DateTime(2018, 3, 15), 18),
            new EmployeeTask(11, 4, "Brochure Design Review", "Cindy Stanwick", new DateTime(2017, 8, 22), new DateTime(2017, 10, 28), 4),
            new EmployeeTask(12, 4, "Review Website Redesign Strategy", "Sammy Hill", new DateTime(2017, 9, 16), new DateTime(2018, 3, 6), 73),
            new EmployeeTask(13, 4, "Roll Out New Website", "Davey Jones", new DateTime(2017, 11, 7), new DateTime(2018, 2, 6), 9),
            new EmployeeTask(14, 4, "Update Sales/Marketing Strategy", "Victor Norris", new DateTime(2017, 12, 13), new DateTime(2018, 4, 2), 5),
            new EmployeeTask(15, 4, "Update Sales/Revenue Report", "Mary Stern", new DateTime(2017, 12, 25), new DateTime(2018, 4, 2), 4),
            new EmployeeTask(16, 4, "Direct vs Online Sales Comparison Report", "Robin Cosworth", new DateTime(2018, 1, 2), new DateTime(2018, 3, 20), 14),
            new EmployeeTask(17, 4, "Review Sales Report and Approve Modifications", "Kelly Rodriguez", new DateTime(2017, 9, 4), new DateTime(2017, 10, 30), 8),
            new EmployeeTask(18, 4, "Update R&D Strategy", "James Anderson", new DateTime(2017, 11, 13), new DateTime(2017, 12, 4), 12),
            new EmployeeTask(19, 4, "Discuss Updated R&D Strategy", "Antony Remmen", new DateTime(2017, 10, 29), new DateTime(2017, 12, 31), 14),
            new EmployeeTask(20, 4, "Update QA Strategy", "Olivia Peyton", new DateTime(2017, 10, 31), new DateTime(2017, 11, 2), 18),
            new EmployeeTask(21, 4, "Schedule Training Events", "Taylor Riley", new DateTime(2017, 11, 19), new DateTime(2018, 4, 7), 21),
            new EmployeeTask(22, 4, "Approve Hiring of John Jeffers", "Amelia Harper", new DateTime(2018, 1, 7), new DateTime(2018, 4, 8), 10),
            new EmployeeTask(23, 0, "Increase Average Subscription Price", "Wally Hobbs", new DateTime(2017, 8, 9), new DateTime(2017, 9, 13), 96),
            new EmployeeTask(24, 23, "Update Non-Compete Agreements", "Brad Jameson", new DateTime(2017, 8, 9), new DateTime(2017, 9, 3), 96),
            new EmployeeTask(25, 23, "Update Employee Records with New NDA", "Karen Goodson", new DateTime(2017, 8, 23), new DateTime(2018, 9, 10), 100)
        };
    }
}
csharp
// ...
builder.Services.AddSingleton<EmployeeTaskService>();

Built-in Commands

The table below lists context menu types and built-in commands available in the TreeList:

- The context menu includes this item by default.
- You can add this item to the context menu.

Menu ItemData RowFooterHeader
AutoFitAll
ClearColumnSorting
CollapseAll
ExpandAll
HideColumn
ShowColumnChooser
ShowFilterBuilder
SortColumnAscending
SortColumnDescending

Access Items

The Items event argument contains an initial item collection. This collection depends on the menu type, TreeList settings, and component state. For instance, a header context menu contains the SortColumnAscending command only if sorting is allowed (on both TreeList and column levels). The ClearColumnSorting command is disabled if the target column is not sorted.

Call a Contains method overload to check whether the context menu includes a particular item. Obtain an item by its name or index:

csharp
void CustomizeContextMenu(TreeListCustomizeContextMenuEventArgs args) {    
    // Returns the first item
    IContextMenuItem firstItem = args.Items[0];
    // Returns the "Auto Fit All" item
    IContextMenuItem autoFitItem;
    if (args.Items.Contains(TreeListContextMenuDefaultItemNames.AutoFitAll))
        autoFitItem = args.Items[TreeListContextMenuDefaultItemNames.AutoFitAll];
}

Add Items

Add Built-In Items

The TreeListContextMenuDefaultItemNames class contains names of all built-in items. Pass an item name to an Add method overload to add this item to the context menu. Refer to the following section for a list of predefined items: Built-in Commands.

Note

The TreeList validates item collections for each context menu type and hides unsupported commands (even if you add these commands in the CustomizeContextMenu event handler).

csharp
void CustomizeContextMenu(TreeListCustomizeContextMenuEventArgs args) {  
      // Inserts the "Auto Fit All" item at the end of the item collection
      args.Items.Add(TreeListContextMenuDefaultItemNames.AutoFitAll);
      // Inserts the "Show Column Chooser" item at the first position in the item collection
      args.Items.Add(0, TreeListContextMenuDefaultItemNames.ShowColumnChooser);
}

Add Custom Items

AddCustomItem method overloads allow you to create a custom item and add it to the item collection:

csharp
void CustomizeContextMenu(TreeListCustomizeContextMenuEventArgs args) {
    // Inserts a custom item at the first position in the item collection
    var isFooterVisible = args.TreeList.FooterDisplayMode != TreeListFooterDisplayMode.Never;
    string footerItemText = isFooterVisible ? "Hide Footer" : "Show Footer";
    var newState = isFooterVisible ? TreeListFooterDisplayMode.Never : TreeListFooterDisplayMode.Always;
    args.Items.AddCustomItem(0, footerItemText, () => {
        args.TreeList.BeginUpdate();
        args.TreeList.FooterDisplayMode = newState;
        args.TreeList.EndUpdate();
    });
    // Inserts a custom item at the end of the item collection
    if (args.Context is TreeListHeaderCommandContext headerContext) {
        if (headerContext.Column is ITreeListCommandColumn commandColumn) {
            var isFixed = commandColumn.FixedPosition != TreeListColumnFixedPosition.None;
            string fixedItemText = isFixed ? "Unfix Column" : "Fix Column to the Left";
            var newValue = isFixed ? TreeListColumnFixedPosition.None : TreeListColumnFixedPosition.Left;
            args.Items.AddCustomItem(fixedItemText, () => {
                headerContext.TreeList.BeginUpdate();
                headerContext.Column.FixedPosition = newValue;
                headerContext.TreeList.EndUpdate();
            });
        }
    }
}

Add Nested Items

Built-in context menu commands do not have nested items. Use a command’s Items property to add nested menu items:

csharp
void CustomizeContextMenu(TreeListCustomizeContextMenuEventArgs args) {  
    if (args.Context is TreeListHeaderCommandContext headerContext) {
        // Inserts a custom item at the first position in the item collection
        var sortItem = args.Items.AddCustomItem(0, "Sort...");
        // Adds default items to the item collection of the inserted item
        sortItem.Items.Add(TreeListContextMenuDefaultItemNames.SortColumnAscending);
        sortItem.Items.Add(TreeListContextMenuDefaultItemNames.SortColumnDescending);
        sortItem.Items.Add(TreeListContextMenuDefaultItemNames.ClearColumnSorting);
    }
}

Remove Items

Remove method overloads allow you to remove an item with the specified name or index from the item collection. To remove all items from the collection, call the Clear() method.

csharp
void CustomizeContextMenu(TreeListCustomizeContextMenuEventArgs args) {
    // Removes the first item
    args.Items.Remove(0);
    // Removes the "Show Column Chooser" item
    args.Items.Remove(TreeListContextMenuDefaultItemNames.ShowColumnChooser);
    // Removes all items
    args.Items.Clear();
}

Customize Items

Access an item and use its properties to customize command availability, appearance, and behavior.

csharp
void CustomizeContextMenu(TreeListCustomizeContextMenuEventArgs args) {
    // Hides icons for all built-in commands
    foreach(var item in args.Items)
        item.IconUrl = string.Empty;   
    if (args.Context is TreeListHeaderCommandContext headerContext) {
        // Removes the "Sort Column Descending" item
        args.Items.Remove(TreeListContextMenuDefaultItemNames.SortColumnDescending);
        // Changes the "Sort Column Ascending" item caption
        args.Items[TreeListContextMenuDefaultItemNames.SortColumnAscending].Text = "Sort";
        // Adds and configures a custom command for the command column header
        if (headerContext.Column is ITreeListCommandColumn commandColumn) {
            var isFixed = commandColumn.FixedPosition != TreeListColumnFixedPosition.None;
            string itemText = isFixed ? "Unfix Column" : "Fix Column to the Left";
            var newValue = isFixed ? TreeListColumnFixedPosition.None : TreeListColumnFixedPosition.Left;

            var fixColumnItem = args.Items.AddCustomItem(itemText, () => {
                headerContext.TreeList.BeginUpdate();
                headerContext.Column.FixedPosition = newValue;
                headerContext.TreeList.EndUpdate();
            });
            fixColumnItem.BeginGroup = true;
        }
    }
}

See Also

DxTreeList Class

DxTreeList Members

DevExpress.Blazor Namespace