menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridBanneredRangesChangedEventArgs - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridBanneredRangesChangedEventArgs

    Provides data about the BanneredRangesChanged event.

    Inheritance
    System.Object
    System.EventArgs
    SyncfusionEventArgs
    SyncfusionSuccessEventArgs
    GridBanneredRangesChangedEventArgs
    Inherited Members
    SyncfusionEventArgs.ToString()
    SyncfusionSuccessEventArgs.Success
    System.EventArgs.Empty
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Syncfusion.Windows.Forms.Grid
    Assembly: Syncfusion.Grid.Windows.dll
    Syntax
    public sealed class GridBanneredRangesChangedEventArgs : SyncfusionSuccessEventArgs
    Remarks

    GridBanneredRangesChangedEventArgs is a custom event argument class used by the BanneredRangesChanged event.

    This event is raised by the model to notify all associated views that the grid model changes a range(s) of cells to appear as bannered cells or resets the bannering 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 if 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

    GridBanneredRangesChangedEventArgs(GridRangeInfoList, Boolean, Boolean)

    Initializes the new instances of the GridBanneredRangesChangedEventArgs class.

    Declaration
    public GridBanneredRangesChangedEventArgs(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 bannered ranges or if bannering 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
    GridRangeInfoList

    SetOrReset

    Gets a value indicating whether the specified ranges should be made bannered ranges or if bannering should be removed.

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

    True if bannered ranges; False if bannering should be removed.

    See Also

    GridBanneredRangesChangedEventHandler
    Remove(GridRangeInfo)
    Add(GridRangeInfo)
    GridBanneredRangesChangingEventArgs
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved