Class CellEditArgs<T>

Provides information about the OnCellEdit event.

Inheritance
System.Object
GridEventBaseArgs
CellEditArgs<T>
Inherited Members
Namespace: Syncfusion.Blazor.Grids
Assembly: Syncfusion.Blazor.dll
Syntax
public class CellEditArgs<T> : GridEventBaseArgs
Type Parameters
Name Description
T

TValue of the grid component.

Constructors

CellEditArgs()

Declaration
public CellEditArgs()

Properties

Cancel

Gets or sets a value indicating whether to cancel the edit action of the cell

Declaration
public bool Cancel { get; set; }
Property Value
Type Description
System.Boolean

The default value is false. If the Cancel property is set to true, then the edit action of the cell will be cancelled.

Cell

Defines the cell object.

Declaration
public DOM Cell { get; set; }
Property Value
Type
DOM

Column

Gets the GridColumn associated with the currently selected cell for editing.

Declaration
public GridColumn Column { get; }
Property Value
Type Description
GridColumn

A GridColumn object representing the column associated with the currently selected cell for editing.

ColumnName

Gets the name of the Field of the currently selected cell for editing.

Declaration
public string ColumnName { get; }
Property Value
Type Description
System.String

A string representing the field name of the currently selected cell for editing.

ColumnObject

Gets the GridColumn associated with the currently selected cell for editing.

Declaration
public GridColumn ColumnObject { get; }
Property Value
Type Description
GridColumn

A GridColumn object representing the column associated with the currently selected cell for editing.

Data

Gets the changed data associated with the currently selected cell for editing.

Declaration
public T Data { get; set; }
Property Value
Type Description
T

An object of type T representing the changed data associated with the currently selected cell for editing.
Remarks

When editing a cell, you can change the cell value either in the edit form or programmatically in the OnCellSave event handler. The new value is updated in the underlying data source and displayed in the edited cell and in the edit form (if open).

EditContext

Gets the data related to the editing process, such as flags indicating which fields have been modified and the current set of validation messages.

Declaration
public EditContext EditContext { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.Forms.EditContext

An instance of the Microsoft.AspNetCore.Components.Forms.EditContext class that provides data about the editing process.

ForeignKeyData

Gets the foreign key column data of the data grid.

Declaration
public IDictionary<string, IEnumerable<object>> ForeignKeyData { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Collections.Generic.IEnumerable<System.Object>>

A dictionary that represents the foreign key column data. Each key represents a foreign key column name and the value represents the associated data as an enumerable object.

IsForeignKey

Gets the boolean property value indicating whether the edited cell is associated with a foreign key column.

Declaration
public bool IsForeignKey { get; }
Property Value
Type Description
System.Boolean

The value true if the edited cell is associated with foreign key column, otherwise it is false.

PrimaryKey

Gets the list of IsPrimaryKey true field names of the column.

Declaration
public string[] PrimaryKey { get; }
Property Value
Type Description
System.String[]

The list of Field names of the column with IsPrimaryKey set to true.

Row

Defines the current row.

Declaration
public DOM Row { get; set; }
Property Value
Type
DOM

RowData

Gets the original data associated with the currently selected cell for editing.

Declaration
public T RowData { get; }
Property Value
Type Description
T

An object of type T representing the data associated with the currently selected cell for editing.

Type

Defines the name of the event.

Declaration
public string Type { get; set; }
Property Value
Type
System.String

ValidationRules

Gets the ValidationRules associated with the currently selected cell for editing.

Declaration
public ValidationRules ValidationRules { get; }
Property Value
Type
ValidationRules

Value

Gets the cell value associated with the currently selected cell for editing.

Declaration
public string Value { get; set; }
Property Value
Type
System.String