Class GridColumnChooserController

Represents a controller that serves the functionality to add or remove columns dynamically at column chooser window.

Inheritance
System.Object
GridColumnDragDropController
GridColumnChooserController
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.Grid
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public class GridColumnChooserController : GridColumnDragDropController, IDisposable

Constructors

GridColumnChooserController(SfDataGrid, IColumnChooser)

Initializes a new instance of GridColumnChooserController class.

Declaration
public GridColumnChooserController(SfDataGrid dataGrid, IColumnChooser columnChooserwindow)
Parameters
Type Name Description
SfDataGrid dataGrid

The SfDataGrid.
IColumnChooser columnChooserwindow

The column chooser window.

Properties

AllowHidingForFinalColumn

Gets or sets a value that indicates whether the last column can be drag in the view of column chooser.

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

true if the last column should be hidden in the view of column chooser; otherwise , false.

Methods

CanShowPopup(GridColumn)

Determines whether the popup is displayed at the specified column.

Declaration
public override bool CanShowPopup(GridColumn column)
Parameters
Type Name Description
GridColumn column

The corresponding column to show the popup.
Returns
Type Description
System.Boolean

Returns true if the popup is displayed at the specified column; otherwise, false.
Overrides

OnColumnHiddenChanged(GridColumn)

Invoked when the property value changes.

Declaration
protected override void OnColumnHiddenChanged(GridColumn column)
Parameters
Type Name Description
GridColumn column

The corresponding column on which the property value changes occurs.
Overrides

OnColumnWidthChanged(GridColumn)

Invoked when the property value changes.

Declaration
protected override void OnColumnWidthChanged(GridColumn column)
Parameters
Type Name Description
GridColumn column

The corresponding column on which the property value changes occurs.
Overrides

OnPopupContentDropped(Point)

Invoked when the popup content dropped on SfDataGrid.

Declaration
protected override void OnPopupContentDropped(Point pointOverGrid)
Parameters
Type Name Description
System.Windows.Point pointOverGrid

Indicates whether the mouse point is hovered inside or out of the SfDataGrid.
Overrides

OnPopupContentPositionChanged(Double, Double, Point)

Invoked when the position of popup content is changed in SfDataGrid.

Declaration
protected override void OnPopupContentPositionChanged(double HorizontalDelta, double VerticalDelta, Point mousePointOverGrid)
Parameters
Type Name Description
System.Double HorizontalDelta

The corresponding horizontal distance of the popup content position changes.
System.Double VerticalDelta

The corresponding vertical distance of the popup content position changes.
System.Windows.Point mousePointOverGrid

Indicates whether the mouse point is hovered inside or out of the SfDataGrid.
Overrides

PointToGridRegion(Point)

Gets the corresponding GridRegion at the specified pointer position.

Declaration
public override GridRegion PointToGridRegion(Point point)
Parameters
Type Name Description
System.Windows.Point point

The position to get the corresponding grid region.
Returns
Type Description
GridRegion

Returns the corresponding GridRegion at the specified point.
Overrides

Show(Int32, MouseEventArgs)

Shows the popup for the specified column index to enable drag and drop operation.

Declaration
public void Show(int colIndex, MouseEventArgs e)
Parameters
Type Name Description
System.Int32 colIndex

The index of the column to enable popup.
System.Windows.Input.MouseEventArgs e

The System.Windows.Input.MouseEventArgs that contains the corresponding mouse point.

Implements

System.IDisposable