Class GridCellTextEventArgs
Provides event data for the QueryCellText, SaveCellText, QueryCellFormattedText, or SaveCellFormattedText event.
Namespace: Syncfusion.Windows.Controls.Grid
Assembly: Syncfusion.Grid.Wpf.dll
Syntax
public sealed class GridCellTextEventArgs : SyncfusionHandledEventArgsRemarks
If you want to customize the grid's behavior, you should set Handled to True. The grid will check this flag to see whether it should accept your modification or use a conversion.
If you need identity information about the cell such as row and column index, you can get that information by querying CellIdentity of the Style object.
The SaveCellFormattedText and SaveCellText events expect that you save the resulting value in CellValue of the Style object.
The QueryCellFormattedText and QueryCellText events expect that you save the resulting string in Text.
The TextInfo is only used for SaveCellFormattedText and QueryCellFormattedText.
Constructors
GridCellTextEventArgs(String, GridStyleInfo, Object, Int32)
Initalizes a new object.
Declaration
public GridCellTextEventArgs(string text, GridStyleInfo style, object value, int textInfo)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | text | The string that represents the underlying cell value. |
| GridStyleInfo | style | The style object. |
| System.Object | value | The cell value. |
| System.Int32 | textInfo | TextInfo is a hint where the call originated, e.g. GridCellBaseTextInfo.DisplayText. |
Properties
Style
The style object.
Declaration
[TraceProperty(true)]
public GridStyleInfo Style { get; }Property Value
| Type |
|---|
| GridStyleInfo |
Text
The string that represents the underlying cell value.
Declaration
[TraceProperty(true)]
public string Text { get; set; }Property Value
| Type |
|---|
| System.String |
TextInfo
textInfo is a hint where the call originated, e.g. GridCellBaseTextInfo.DisplayText.
Declaration
[TraceProperty(true)]
public int TextInfo { get; }Property Value
| Type |
|---|
| System.Int32 |
Value
The cell value.
Declaration
[TraceProperty(true)]
public object Value { get; }Property Value
| Type |
|---|
| System.Object |