Class GridCoveredRangesChangedEventArgs

Provides data about the CoveredRangesChanged event.

Inheritance
System.Object
System.EventArgs
SyncfusionEventArgs
SyncfusionSuccessEventArgs
GridCoveredRangesChangedEventArgs
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 GridCoveredRangesChangedEventArgs : SyncfusionSuccessEventArgs
Remarks

GridCoveredRangesChangedEventArgs is a custom event argument class used by the CoveredRangesChanged event.

This event is raised by the model to notify all associated views that the grid model changed a range(s) of cells to appear as covered cells or reset the covering for a list of ranges.

This event is raised to make sure all associated views redraw affected display contents. The change can be originated programmatically by a method call to Remove(GridRangeInfo) or Add(GridRangeInfo).

The Success property indicates whether all changes were successfully made to the model. If it is False, the operation was aborted. However, the view contents need to be redrawn no matter if the operation was successful or not.

Constructors

GridCoveredRangesChangedEventArgs(GridRangeInfoList, Boolean, Boolean)

Initializes the new instances of the GridCoveredRangesChangedEventArgs class.

Declaration
public GridCoveredRangesChangedEventArgs(GridRangeInfoList ranges, bool setOrReset, bool success)
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.
System.Boolean success

Indicates whether an operation was successful.

Properties

Ranges

Gets a GridRangeInfoList with a list of affected ranges.

Declaration
public GridRangeInfoList Ranges { get; }
Property Value
Type Description
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.

See Also