ASPxClientGantt.CustomCommand Event

Enables you to implement a custom command’s logic.

Declaration

TypeScript

CustomCommand: ASPxClientEvent<ASPxClientGanttCustomCommandEventHandler<ASPxClientGantt>>

Event Data

The CustomCommand event's data class is ASPxClientGanttCustomCommandEventArgs. The following properties provide information specific to this event:

Property	Description
commandName	Specifies the command name for a custom toolbar item.
parameter	Gets an optional parameter that complements the processed command.

Remarks

You can use the CustomCommand event to handle clicks on custom toolbar and context menu items.

Web Forms:

ASPX

<dx:ASPxGantt ID="Gantt" ClientInstanceName="clientGantt" >
    <SettingsToolbar>
        <Items>
            <dx:GanttCustomToolbarItem Checked="True" Text="Show Resources" CommandName="Toggle" />
        </Items>
    </SettingsToolbar>
    <ClientSideEvents CustomCommand="function(s, e) {
        if(e.commandName == 'Toggle') {
            clientGantt.ShowResources(e.parameter);
        }
    }" />
</dx:ASPxGantt>

MVC:

Razor C#

@Html.DevExpress().Gantt(settings => {
    settings.Name = "gantt";
    settings.SettingsToolbar.Items.AddCustomItem(i => {
        i.Checked = true;
        i.Text = "Show Resources";
        i.CommandName = "ShowResources";
    });    
    settings.ClientSideEvents.CustomCommand = "function (s, e) { 
        if(e.commandName == 'Toggle') {
            clientGantt.ShowResources(e.parameter);
        }      
    }";
    ...
}).Bind(
    GanttDataProvider.Tasks, GanttDataProvider.Dependencies, 
    GanttDataProvider.Resources, GanttDataProvider.ResourceAssignments
).GetHtml()

Examples

• Show and Hide Toolbar

• Create a Standard Toolbar Item

• Create a Custom Toolbar Item

• Context Menu: Add an Item

• Hide the Built-In Context Menu