Class GridPasteCellTextEventArgs

Provides data about the PasteCellText event which can be marked as handled.

Inheritance
System.Object
SyncfusionCancelEventArgs
GridPasteCellTextEventArgs
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public sealed class GridPasteCellTextEventArgs : SyncfusionCancelEventArgs
Remarks

GridPasteCellTextEventArgs is a custom event argument class used by the PasteCellText event to save text information into a specified cell.

This event allows you to customize how to handle text pasted into a cell at run-time on demand.

If you do not wish the grid to make any changes to the cell, set System.ComponentModel.CancelEventArgs.Cancel to True. The grid will check this flag to see whether it should make changes to the cell.

If you wish that the grid aborts the current paste operation (in case several cells are pasted), set the Abort flag to True.

The GridPasteCellTextEventArgs members, e.ColIndex and e.RowIndex, specify column and row of the cell. The e.Style member holds the GridStyleInfo object for the cell.

Constructors

GridPasteCellTextEventArgs(Int32, Int32, GridStyleInfo, String, Boolean)

Initializes a new instances ofGridPasteCellTextEventArgs class.

Declaration
public GridPasteCellTextEventArgs(int rowIndex, int colIndex, GridStyleInfo style, string text, bool abort)
Parameters
Type Name Description
System.Int32 rowIndex

The row index.
System.Int32 colIndex

The column index.
GridStyleInfo style

The style information for the cell.
System.String text

The text to be pasted into the cell.
System.Boolean abort

Specifies if operation should be aborted.

Properties

Abort

Gets or sets a value indicating whether operation should be aborted.

Declaration
[TraceProperty(true)]
public bool Abort { get; set; }
Property Value
Type
System.Boolean

ColIndex

Gets the column index.

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

RowIndex

Gets the row index.

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

Style

Gets the style information for the cell.

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

Text

Gets or sets the text to be pasted into the cell.

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

See Also