menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ColumnChooserEventArgs - API Reference

    Show / Hide Table of Contents

    Class ColumnChooserEventArgs

    Provides information about an BeforeOpenColumnChooser event.

    Inheritance
    System.Object
    GridEventBaseArgs
    ColumnChooserEventArgs
    Inherited Members
    GridEventBaseArgs.PreventRender
    Namespace: Syncfusion.Blazor.Grids
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class ColumnChooserEventArgs : GridEventBaseArgs

    Constructors

    ColumnChooserEventArgs()

    Declaration
    public ColumnChooserEventArgs()

    Properties

    Cancel

    Gets or sets a value indicating whether to cancel the column chooser popup open.

    Declaration
    public bool Cancel { get; set; }
    Property Value
    Type Description
    System.Boolean

    The default value is false, If the Cancel property is set to true, then the column chooser popup open will be cancelled.

    Columns

    Gets the list of GridColumn that is being displayed in the column chooser pop up.

    Declaration
    public List<GridColumn> Columns { get; }
    Property Value
    Type Description
    System.Collections.Generic.List<GridColumn>

    The list of columns that is being displayed in the column chooser pop up. The default value is null.

    DialogInstance

    Gets the instance of the column chooser dialog.

    Declaration
    public SfDialog DialogInstance { get; }
    Property Value
    Type Description
    SfDialog

    A SfDialog representing the instance of the column chooser dialog.

    Element

    Defines the parent element.

    Declaration
    public DOM Element { get; set; }
    Property Value
    Type Description
    DOM

    RequestType

    Gets the current Action performed when the column chooser is clicked to open.

    Declaration
    public Action RequestType { get; }
    Property Value
    Type Description
    Action

    The action performed when the column chooser is clicked to open. The default value is BeforeOpenColumnChooser.

    SearchOperator

    Gets or sets the search operator for the column chooser search request.

    Declaration
    public string SearchOperator { get; set; }
    Property Value
    Type Description
    System.String

    The string value representing the search operator. By default, the value is StartsWith.

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved