How to change the Enter key behavior to insert line break when the CurrentCell is in the edit mode for WPF Grid?

In SfDataGrid, by default when you press Enter key, the CurrentCell moves to next row. To change this behavior like inserting a line break by pressing the Enter key when the CurrentCell is in the edit mode, you can change this Enter key behavior by overriding GridCellSelectionController / GridSelectionController class and setting it to SfDataGrid.SelectionController property.

When SelectionUnit is Cell, you have to override GridCellSelectionController and when SelectionUnit is Row, you have override GridSelectionController class.

You can insert the line break within the TextBox by setting AcceptsReturn to true. AcceptsReturn property allows you to use the TextBox as a multiline input field.

In the following code example, SfDataGrid is defined with SelectionUnit as Cell and Style for TextBox within SfDataGrid.Resources.ResourceDictionary is defined by setting AcceptsReturn to true.

XAML

<syncfusion:SfDataGrid x:Name="sfdatagrid" 
                       RowHeight="50"
                       AllowEditing="True"
                       NavigationMode="Cell"
                       SelectionUnit="Cell"
                       SelectionMode="Single"
                       AllowResizingColumns="False"
                       ItemsSource="{Binding Products}">
 
    <syncfusion:SfDataGrid.Resources>
        <ResourceDictionary>
            <Style TargetType="TextBox">
                <Setter Property="AcceptsReturn" Value="True"/>
            </Style>
        </ResourceDictionary>
    </syncfusion:SfDataGrid.Resources>
</syncfusion:SfDataGrid>

The following code example shows you how to set the instance of GridCellSelectionControllerExt that is derived from GridCellSelectionController to SfDataGird.SelectionController property.

C#

public MainWindow()
{
InitializeComponent();
this.sfdatagrid.SelectionController = new GridCellSelectionControllerExt(sfdatagrid);
}

The following code example explains you how to override the GridCellSelectionController class.

C#

using Syncfusion.UI.Xaml.Grid;
public class GridCellSelectionControllerExt : GridCellSelectionController
{
public GridCellSelectionControllerExt(SfDataGrid dataGrid)
    : base(dataGrid)
    {
           
    }
}

By default SfDataGrid handles Enter key. You can change this behavior by setting KeyEventArgs.Handled to false in ProcessKeyDown override method as in the following code example.

C#

using System.Windows.Input;
public class GridCellSelectionControllerExt : GridCellSelectionController
{
    public GridCellSelectionControllerExt(SfDataGrid dataGrid)
    : base(dataGrid)
    {
    }
    protected override void ProcessKeyDown(KeyEventArgs args)
    {
        if(args.Key == Key.Enter)
        {
            args.Handled = false;
            return;
        }
        base.ProcessKeyDown(args);
    }
}

In the following screenshot SfDataGrid allows you to enter multiline inputs while editing.

Sample Links:

WPF

WRT
SilverLight

UWP