Class GridCellTextEventArgs

Provides event data for the QueryCellText, SaveCellText, QueryCellFormattedText, or SaveCellFormattedText event.

Inheritance
System.Object
System.EventArgs
SyncfusionEventArgs
SyncfusionHandledEventArgs
GridCellTextEventArgs
Inherited Members
System.EventArgs.Empty
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public sealed class GridCellTextEventArgs : SyncfusionHandledEventArgs
Remarks

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)

Initializes the new instances of GridCellTextEventArgs class.

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

The textInfo is a hint where the call originated, e.g. GridCellBaseTextInfo.DisplayText.

Properties

Style

Gets the style object.

Declaration
[TraceProperty(true)]
public GridStyleInfo Style { get; }
Property Value
Type Description
GridStyleInfo

Text

Gets or sets the string that represents the underlying cell value.

Declaration
[TraceProperty(true)]
public string Text { get; set; }
Property Value
Type Description
System.String

TextInfo

Gets the textInfo as a hint where the call is originated, e.g. GridCellBaseTextInfo.DisplayText.

Declaration
[TraceProperty(true)]
public int TextInfo { get; }
Property Value
Type Description
System.Int32

Value

Gets the cell value.

Declaration
[TraceProperty(true)]
public object Value { get; }
Property Value
Type Description
System.Object

See Also

ApplyFormattedText(GridStyleInfo, System.String, System.Int32)