Class GridQueryScrollCellInViewEventArgs
Provides the data for the QueryScrollCellInView event.
Inheritance
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public class GridQueryScrollCellInViewEventArgs : SyncfusionHandledEventArgs
Remarks
Used by QueryScrollCellInView.
QueryScrollCellInView occurs before a cell is scrolled into view by a ScrollCellInView call. Normally, the current cell is checked if it is inside the visible grid area when certain user events occur such as when a key is pressed or when the grid got focus. The event is called to check whether the specified cell is in view. If the cell is not in view, the grid will scroll it into view. You can hook into this mechanism by implementing a event handler for this event.
Constructors
GridQueryScrollCellInViewEventArgs(Int32, Int32, GridScrollCurrentCellReason)
Initializes the new instances for the GridQueryScrollCellInViewEventArgs class.
Declaration
public GridQueryScrollCellInViewEventArgs(int rowIndex, int colIndex, GridScrollCurrentCellReason reason)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | rowIndex | The row index. |
System.Int32 | colIndex | The column index. |
GridScrollCurrentCellReason | reason | The reason for scrolling cell into view. |
Properties
ColIndex
Gets or sets the column index.
Declaration
[TraceProperty(true)]
public int ColIndex { get; set; }
Property Value
Type |
---|
System.Int32 |
Reason
Gets or sets the reason for scrolling cell into view.
Declaration
[TraceProperty(true)]
public GridScrollCurrentCellReason Reason { get; set; }
Property Value
Type |
---|
GridScrollCurrentCellReason |
Result
Gets or sets a value indicating whether the cell needs to be scrolled into view. The resulting value. Set this to True if cell needs to be scrolled into view; False if not. Don't forget to also set Handled to true.
Declaration
[TraceProperty(true)]
public bool Result { get; set; }
Property Value
Type |
---|
System.Boolean |
RowIndex
Gets or sets the row index.
Declaration
[TraceProperty(true)]
public int RowIndex { get; set; }
Property Value
Type |
---|
System.Int32 |