Class GridCoveredRangesChangingEventArgs
Provides data about the cancelable CoveredRangesChanging event.
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid
Assembly: Syncfusion.Grid.Windows.dll
Syntax
public sealed class GridCoveredRangesChangingEventArgs : SyncfusionCancelEventArgs
Remarks
GridCoveredRangesChangingEventArgs is a custom event argument class used by the CoveredRangesChanging event.
This event is raised by the model to notify all associated views that it is about to make a range(s) of cells appear as covered cells or reset the covering for a list of ranges.
This event is raised to make sure all associated views prepare to redraw affected display contents. The change can be originated programmatically by a method call to Remove(GridRangeInfo) or Add(GridRangeInfo).
The event handler can abort this operation by assigning True to the System.ComponentModel.CancelEventArgs.Cancel property. No changes will then take place in the grid model.
Constructors
GridCoveredRangesChangingEventArgs(GridRangeInfoList, Boolean)
Initializes the new instances of the GridCoveredRangesChangingEventArgs class.
Declaration
public GridCoveredRangesChangingEventArgs(GridRangeInfoList ranges, bool setOrReset)
Parameters
Type | Name | Description |
---|---|---|
GridRangeInfoList | ranges | A GridRangeInfoList with a list of affected ranges. |
System.Boolean | setOrReset | Specifies whether the specified ranges should be made covered ranges or if covering should be removed. |
Properties
Ranges
Gets a GridRangeInfoList with a list of affected ranges.
Declaration
[TraceProperty(true)]
public GridRangeInfoList Ranges { get; }
Property Value
Type |
---|
GridRangeInfoList |
SetOrReset
Gets a value indicating whether the specified ranges should be made covered ranges or if covering should be removed.
Declaration
[TraceProperty(true)]
public bool SetOrReset { get; }
Property Value
Type | Description |
---|---|
System.Boolean | True if covered ranges; False is covering should be removed. |