WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridBanneredRangesChangingEventArgs - WindowsForms API Reference | Syncfusion BanneredRangesChanging event. ">

    Show / Hide Table of Contents

    Class GridBanneredRangesChangingEventArgs

    Provides data about the cancelable BanneredRangesChanging event.

    Inheritance
    System.Object
    SyncfusionCancelEventArgs
    GridBanneredRangesChangingEventArgs
    Inherited Members
    SyncfusionCancelEventArgs.ToString()
    Namespace: Syncfusion.Windows.Forms.Grid
    Assembly: Syncfusion.Grid.Windows.dll
    Syntax
    public sealed class GridBanneredRangesChangingEventArgs : SyncfusionCancelEventArgs
    Remarks

    GridBanneredRangesChangingEventArgs is a custom event argument class used by the BanneredRangesChanging 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 bannered cells or reset the bannering 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

    GridBanneredRangesChangingEventArgs(GridRangeInfoList, Boolean)

    Initalizes a new instances ofGridBanneredRangesChangingEventArgsclass.

    Declaration
    public GridBanneredRangesChangingEventArgs(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 bannered ranges or if bannering should be removed.

    Properties

    Ranges

    Gets a GridRangeInfoList with a list of affected ranges.

    Declaration
    [TraceProperty(true)]
    public GridRangeInfoList Ranges { get; }
    Property Value
    Type Description
    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

    GridBanneredRangesChangingEventHandler
    Remove(GridRangeInfo)
    Add(GridRangeInfo)
    GridBanneredRangesChangedEventArgs
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved