Editing Command

The RadDataGrid control provides the following commands for editing the data inside the column:

  • BeginEdit: Provides an entry point just befor the editing begins.
  • CancelEdit: Provides an entry point just before the editing is canceled.
  • CommitEdit: Provides an entry point just before the editing is commited.

The execution parameter of the Editing Commands is of type EditContext that exposes the following properties:

  • CellInfo: Gets the cell info associated with the operation.
  • TriggerAction: Gets the SourceTriggerAction value that triggered the operation.
  • Parameter: Gets an optional parameter holding additional information associated with the operation.

BeginEdit and CommitEdit Commands Example

Here is an example how the RadDataGrid Editing Commands work:

First, create the needed business objects, for example type Data with the following properties:

public class Data
{
    public string Country { get; set; }

    public string Capital { get; set; }
}

Then create a ViewModel with a collection of Data objects:

public class ViewModel
{
    public ObservableCollection<Data> Items { get; set; }

    public ViewModel()
    {
        this.Items = new ObservableCollection<Data>()
        {
            new Data { Country = "India", Capital = "New Delhi"},
            new Data { Country = "South Africa", Capital = "Cape Town"},
            new Data { Country = "Nigeria", Capital = "Abuja" },
            new Data { Country = "Singapore", Capital = "Singapore" }
        };
    }
}

Then handle the BeginEdit action as a Command. First, create a class that inherits from the DataGridCommand and set its Id property accordingly. You would also need to override CanExecute and Execute methods as demostrated in the example below:

public class BeginEditCommand : DataGridCommand
{
    public BeginEditCommand()
    {
        this.Id = DataGridCommandId.BeginEdit;
    }

    public override void Execute(object parameter)
    {
        var context = (EditContext)parameter;
        var cellEdit = $"BeginEdit on: {context.CellInfo.Value} via {context.TriggerAction} \n";
        Application.Current.MainPage.DisplayAlert("", "" + cellEdit, "OK");
        this.Owner.CommandService.ExecuteDefaultCommand(DataGridCommandId.BeginEdit, parameter);
    }
}

Then handle the CommitEdit action as a Command. First, create a class that inherits from the DataGridCommand and set its Id property accordingly. You would also need to override CanExecute and Execute methods as demostrated in the example below:

public class CommitEditCommand : DataGridCommand
{
    public CommitEditCommand()
    {
        this.Id = DataGridCommandId.CommitEdit;
    }

    public override void Execute(object parameter)
    {
        var context = (EditContext)parameter;

        Application.Current.MainPage.DisplayAlert("", "Edit Committed", "OK");
        this.Owner.CommandService.ExecuteDefaultCommand(DataGridCommandId.CommitEdit, parameter);
    }
}

Then add this Commands to the Commands collection of the RadDataGrid instance:

this.BindingContext = new ViewModel();
dataGrid.Commands.Add(new BeginEditCommand());
dataGrid.Commands.Add(new CommitEditCommand());

Define the RadDataGrid in XAML:

<telerikDataGrid:RadDataGrid x:Name="dataGrid" 
                             ItemsSource="{Binding Items}"
                             UserEditMode="Cell"/>

SDK Samples Browser application contains an example that shows how to use the BeginEdit Command. The Editing example is located in the DataGrid/Commands folder.

See Also

In this article
Not finding the help you need? Improve this article