Class GridQueryBanneredRangeEventArgs

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

Inheritance
System.Object
System.EventArgs
SyncfusionEventArgs
SyncfusionHandledEventArgs
GridCellHandledEventArgs
GridQueryBanneredRangeEventArgs
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 GridQueryBanneredRangeEventArgs : GridCellHandledEventArgs
Remarks

GridQueryBanneredRangeEventArgs is a custom event argument class used by the QueryBanneredRange event to query information about a bannered range at a specified cell.

This event allows you to specify bannered ranges at run-time, e.g when you have a large grid with repeating patterns of bannered ranges. If the specified row and column index is part of a bannered cell's range, you should assign the coordinates of the bannered cell to Range and set Handled to True.

Handled indicates that you supplied data from your event handler and no further querying for data about bannered range information for this cell is necessary.

See the BannerCells sample for an example how to use this event.

Constructors

GridQueryBanneredRangeEventArgs(Int32, Int32)

Initializes the new instances of the GridQueryBanneredRangeEventArgs class.

Declaration
public GridQueryBanneredRangeEventArgs(int rowIndex, int colIndex)
Parameters
Type Name Description
System.Int32 rowIndex

The row index.
System.Int32 colIndex

The column index.

GridQueryBanneredRangeEventArgs(Int32, Int32, GridRangeInfo)

Initializes the new instances of the GridQueryBanneredRangeEventArgs class.

Declaration
public GridQueryBanneredRangeEventArgs(int rowIndex, int colIndex, GridRangeInfo range)
Parameters
Type Name Description
System.Int32 rowIndex

The row index.
System.Int32 colIndex

The column index.
GridRangeInfo range

A GridRangeInfo that will receive the resulting range for the bannered cell.

Properties

Range

Gets or sets a GridRangeInfo that will receive the resulting range for the bannered cell.

Declaration
[TraceProperty(true)]
public GridRangeInfo Range { get; set; }
Property Value
Type Description
GridRangeInfo

See Also