We recommend that you use the xamDataGrid control instead of the xamGrid control. The xamGrid is being planned for retirement over the next few years and will not receive any new features. We will continue to provide support and critical bug fixes for the xamGrid during this time. For help or questions on migrating your codebase to the xamDataGrid, please contact support.
The xamGrid™ control allows your end users to edit data in its rows. You can allow your end users to edit data in two ways: enter edit mode for the entire row or on a cell-by-cell basis. The control supports data that implements the IEditableObject interface and raises the BeginEdit, CancelEdit and EndEdit methods at their appropriate times. The EditingSettings object provides you with many options when it comes to editing in xamGrid. The control’s editing behavior, events, methods, and settings are described below.
Editing of xamGrid’s data can only occur when your end user enters edit mode. This applies to checkbox columns as well - a checkbox is only editable when its cell is in edit mode.
To allow editing for a template column, use the TemplateColumn object’s EditorTemplate property to set a custom editor. For more information about editing a template column, see Editing Data in a Template Column.
To provide your own value converter, set a column’s EditorValueConverter and EditorValueConverterParameter properties.
Enter - Exits edit mode and commits changes.
Up Arrow - Exits edit mode, commits changes, and moves to previous row if there is one.
Down Arrow - Exits edit mode, commits changes, and moves to next row if there is one.
Left Arrow - Exits edit mode, commits changes, and moves to previous cell if there is one. Retains edit mode if edit mode is on entire row and the cell moved to is not on a new row.
Right Arrow - Exits edit mode, commits changes, and moves to next cell if there is one. Retains edit mode if edit mode is on entire row and the cell moved to is not on a new row.
Tab - Moves to next cell and commits changes. Retains edit mode if edit mode is on entire row and the cell moved to is not on a new row.
Escape key - exits edit mode and cancels changes.
Hover a cell - if AllowEditing is set to Hover commits change on previously edited cell if there is such and enters edit mode.
Single click on a cell - if IsMouseActionEditingEnabled is set to SingleClick commits change on previously edited cell if there is such and enters edit mode.
Double click on a cell - if IsMouseActionEditingEnabled is set to DoubleClick commits change on previously edited cell if there is such and enters edit mode.
Perform a click outside the xamGrid - commits change on previously edited cell if there is such.
When AllowEditingValidation is True on a column, exiting edit mode requires that data is valid; i.e, the data your end user enters does not throw an exception. Otherwise, the Escape key needs to be pressed to cancel the change and exit edit mode. For more information on data validation when editing, see Validating Data.
Scrolling with the horizontal scrollbar will not exit edit mode when AllowEditing is set to Row; scrolling with the vertical scrollbar exits both Row and Cell editing.
The xamGrid control provides various editing events for you to implement custom behavior. The following lists the editing events.
The following is a list of editing methods xamGrid provides to enter and exit edit mode from code behind.
The EditingSettings object provides you with a list of properties to set up editing for xamGrid.
AllowEditing – Set the behavior of xamGrid when the end user tries to enter edit mode on a cell. The following EditingType enumeration values are available: Cell, Row, Hover or None.
IsEnterKeyEditingEnabled – Allows entering edit mode with the Enter key.
IsF2EditingEnabled – Allows entering edit mode with F2 key.
IsMouseActionEditingEnabled – Allows entering edit mode with a single or double click.
IsOnCellActiveEditingEnabled – Allows entering edit mode when a cell becomes active, for example with the Tab key.
When you set the AllowEditing property to Hover, the grid will enter in edit mode when you just hover it with the mouse. Use the xamGrid’s RowHover property to specify whether a single cell or the whole row should enter edit mode.
Aside from setting editing options on the entire control, you can also set options on individual ColumnLayout objects. Further, each individual EditableColumn object exposes an IsReadonly property to enable/disable editing on a column basis. The following code shows you how to enable editing on a row-by-row basis for the top level data and a cell-by-cell basis for the nested data.
In XAML:
<ig:XamGrid x:Name="xamGrid1">
<ig:XamGrid.EditingSettings>
<ig:EditingSettings AllowEditing="Row" />
</ig:XamGrid.EditingSettings>
<ig:XamGrid.Columns>
<ig:ColumnLayout Key="Products">
<ig:ColumnLayout.EditingSettings >
<ig:EditingSettingsOverride AllowEditing="Cell" />
</ig:ColumnLayout.EditingSettings >
</ig:ColumnLayout>
</ig:XamGrid.Columns>
</ig:XamGrid>In Visual Basic:
Me.xamGrid1.EditingSettings.AllowEditing = EditingType.Row
Me.xamGrid1.Columns.ColumnLayouts.FromKey("Products").EditingSettings.AllowEditing = EditingType.CellIn C#:
this.xamGrid1.EditingSettings.AllowEditing = EditingType.Row;
this.xamGrid1.ColumnLayouts.FromKey("Products").EditingSettings.AllowEditing = EditingType.Cell;