WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridRowColHideEventArgs - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridRowColHideEventArgs

    Provides data about the Syncfusion.Windows.Forms.Grid.GridModel.QueryHideCol, Syncfusion.Windows.Forms.Grid.GridModel.QueryHideRow, Syncfusion.Windows.Forms.Grid.GridModel.SaveHideCol, and Syncfusion.Windows.Forms.Grid.GridModel.SaveHideRow events which can be marked as handled.

    Inheritance
    System.Object
    System.EventArgs
    SyncfusionEventArgs
    SyncfusionHandledEventArgs
    GridRowColHideEventArgs
    Inherited Members
    SyncfusionHandledEventArgs.Handled
    SyncfusionEventArgs.ToString()
    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 GridRowColHideEventArgs : SyncfusionHandledEventArgs
    Remarks

    GridRowColHideEventArgs is a custom event argument class used by the Syncfusion.Windows.Forms.Grid.GridModel.QueryHideCol, Syncfusion.Windows.Forms.Grid.GridModel.QueryHideRow, Syncfusion.Windows.Forms.Grid.GridModel.SaveHideCol, and Syncfusion.Windows.Forms.Grid.GridModel.SaveHideRow events to query or save if the row or column is hidden in the grid.

    This event allows you to customize the hidden state of row and column at run-time on demand before the grid is drawn or programmatically accessed through Item[Int32].

    If you make changes to Hide, you should also set Handled to True. Syncfusion.Windows.Forms.Grid.GridModel.QueryHideCol and Syncfusion.Windows.Forms.Grid.GridModel.QueryHideRow will return Hide as the actual hide state of the row or column being queried when the event is marked as handled. Otherwise, the grid will check its own data store Dictionary. In the default case when the event is not marked as handled, the grid will locate row and column widths by getting the value from Item[Int32].

    In Syncfusion.Windows.Forms.Grid.GridModel.SaveHideCol and Syncfusion.Windows.Forms.Grid.GridModel.SaveHideRow, the grid will not store row and column hidden state if you mark the event as handled. Otherwise, in the default case that the event is not marked as handled the row and column hidden state is stored by changing the Item[Int32] property.

    note

    The intention of this event is to store and retrieve data. See GridRowColHiddenEventArgs for the related UI event after changes were made to the data store.

    Constructors

    GridRowColHideEventArgs(Int32, Boolean)

    Initializes the new instances of the GridRowColHideEventArgs class.

    Declaration
    public GridRowColHideEventArgs(int index, bool hide)
    Parameters
    Type Name Description
    System.Int32 index

    The row or column index.

    System.Boolean hide

    The hidden flag for the row or column.

    Properties

    Hide

    Gets or sets a value indicating whether the hidden flag for the row or column.

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

    Index

    Gets the row or column index.

    Declaration
    [TraceProperty(true)]
    public int Index { get; }
    Property Value
    Type Description
    System.Int32

    See Also

    GridRowColHideEventHandler
    Syncfusion.Windows.Forms.Grid.GridModel.QueryHideRow
    Syncfusion.Windows.Forms.Grid.GridModel.QueryHideCol
    Syncfusion.Windows.Forms.Grid.GridModel.SaveHideRow
    Syncfusion.Windows.Forms.Grid.GridModel.SaveHideCol
    Syncfusion.Windows.Forms.Grid.GridModelHideColsIndexer
    Syncfusion.Windows.Forms.Grid.GridModelHideRowsIndexer
    IGridRowColHideDictionary
    GetRowHidden(System.Int32)
    GetColHidden(System.Int32)
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved