Class TreeGridColumnDragDropController

Provides the base implementation for column drag-and-drop operations in SfTreeGrid.

Inheritance

System.Object

TreeGridColumnDragDropController

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.TreeGrid

Assembly: Syncfusion.SfGrid.WPF.dll

Syntax

public class TreeGridColumnDragDropController : Object, IDisposable

Remarks

It provides the set of public properties and virtual method to customize the drag-and-drop operation.

Constructors

TreeGridColumnDragDropController(SfTreeGrid)

Initializes a new instance of TreeGridColumnDragDropController class.

Declaration

public TreeGridColumnDragDropController(SfTreeGrid TreeGrid)

Parameters

Type	Name	Description
SfTreeGrid	TreeGrid	The SfTreeGrid.

Properties

PopupContentControl

Gets the PopupContentControl for drag-and-drop operation.

Declaration

protected PopupContentControl PopupContentControl { get; }

Property Value

Type
PopupContentControl

PopupMaxHeight

Gets or sets the maximum height constraint of the popup for drag-and-drop operation.

Declaration

public double PopupMaxHeight { get; set; }

Property Value

Type	Description
System.Double	The maximum height constraint of the popup.

PopupMaxWidth

Gets or sets the maximum width constraint of the popup for drag-and-drop operation.

Declaration

public double PopupMaxWidth { get; set; }

Property Value

Type	Description
System.Double	The maximum width constraint of the popup.

PopupMinHeight

Gets or sets the minimum height constraint of the popup for drag-and-drop operation.

Declaration

public double PopupMinHeight { get; set; }

Property Value

Type	Description
System.Double	The minimum height constraint of the popup.

PopupMinWidth

Gets or sets the minimum width constraint of the popup for drag-and-drop operation.

Declaration

public double PopupMinWidth { get; set; }

Property Value

Type	Description
System.Double	The minimum width constraint of the popup.

Methods

CreatePopupContent(TreeGridColumn)

Creates the popup content for the specified column.

Declaration

protected virtual UIElement CreatePopupContent(TreeGridColumn column)

Parameters

Type	Name	Description
TreeGridColumn	column	The corresponding column to create popup content.

Returns

Type	Description
System.Windows.UIElement	Returns the System.Windows.UIElement for the popup.

Dispose()

Releases all the resources used by the TreeGridColumnDragDropController class.

Declaration

public void Dispose()

Dispose(Boolean)

Disposes all the resources used by the TreeGridColumnDragDropController class.

Declaration

protected virtual void Dispose(bool isDisposing)

Parameters

Type	Name	Description
System.Boolean	isDisposing	Indicates whether the call is from Dispose method or from a finalizer.

GetHeaderRowRect()

Gets the display rectangle for the header row in SfTreeGrid.

Declaration

protected Rect GetHeaderRowRect()

Returns

Type	Description
System.Windows.Rect	The display rectangle for the header row.

GetPopupRect()

Gets the display rectangle for the popup.

Declaration

protected Rect GetPopupRect()

Returns

Type	Description
System.Windows.Rect	The display rectangle for the popup.

OnColumnHiddenChanged(TreeGridColumn)

Invoked when the IsHidden property value changes.

Declaration

protected virtual void OnColumnHiddenChanged(TreeGridColumn column)

Parameters

Type	Name	Description
TreeGridColumn	column	The corresponding column on which the IsHidden property value changes occurs.

OnPopupContentDropped(Point)

Invoked when the popup content dropped on SfTreeGrid.

Declaration

protected virtual void OnPopupContentDropped(Point pointOverGrid)

Parameters

Type	Name	Description
System.Windows.Point	pointOverGrid	Indicates whether the mouse point over on SfTreeGrid.

OnPopupContentPositionChanged(Double, Double, Point)

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

Declaration

protected virtual 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 hover on the TreeGrid.

PointToGridRegion(Point)

Gets the corresponding TreeGridRegion at the specified point co-ordinate value.

Declaration

public virtual TreeGridRegion PointToGridRegion(Point point)

Parameters

Type	Name	Description
System.Windows.Point	point	The position to get the corresponding tree grid region.

Returns

Type	Description
TreeGridRegion	Returns the corresponding TreeGridRegion at the specified point.

PopupContentDroppedOnGrid(Point)

Invoked when the popup content dropped on SfTreeGrid.

Declaration

protected virtual void PopupContentDroppedOnGrid(Point point)

Parameters

Type	Name	Description
System.Windows.Point	point	The corresponding position where the popup content is dropped in SfTreeGrid.

PopupContentDroppedOnHeaderRow(Int32, Int32)

Invoked when the popup content is dropped on header row in SfTreeGrid.

Declaration

protected virtual void PopupContentDroppedOnHeaderRow(int oldIndex, int newColumnIndex)

Parameters

Type	Name	Description
System.Int32	oldIndex	The corresponding old index of the column before dropped the popup content on header row.
System.Int32	newColumnIndex	The new index of the column after dropped the popup content on header row.

Remarks

Override this method and customize the drag-and-drop interaction between columns in SfTreeGrid.

Implements

System.IDisposable