Class SfGridSplitter

SfGridSplitter is used to redistribute space between two adjacent columns or rows. This control, when used in conjunction with Grid, can be used to create flexible and complex user interfaces.

Inheritance

System.Object

SfGridSplitter

Implements

System.IDisposable

Namespace: Syncfusion.Windows.Controls.Input

Assembly: Syncfusion.SfInput.Wpf.dll

Syntax

public class SfGridSplitter : GridSplitter, IDisposable

Constructors

SfGridSplitter()

Initializes a new instance of the System.Windows.Controls.SfGridSplitter class.

Declaration

public SfGridSplitter()

Fields

DownButtonTemplateProperty

The object that defines visual representation of the down button. A DataTemplate representing down arrow symbol,is the default value.

Declaration

public static readonly DependencyProperty DownButtonTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

EnableCollapseButtonProperty

Using a DependencyProperty as the backing store for EnableCollapseButton. This enables animation, styling, and binding.

Declaration

public static readonly DependencyProperty EnableCollapseButtonProperty

Field Value

Type
System.Windows.DependencyProperty

HorizontalGripperTemplateProperty

The object that defines visual representation of the horizontal grid splitter. A DataTemplate representing gripper symbol is the default value.

Declaration

public static readonly DependencyProperty HorizontalGripperTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

LeftButtonTemplateProperty

The object that defines visual representation of the left button. A DataTemplate representing left arrow symbol,is the default value.

Declaration

public static readonly DependencyProperty LeftButtonTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

RightButtonTemplateProperty

The object that defines visual representation of the right button. A DataTemplate representing right arrow symbol,is the default value.

Declaration

public static readonly DependencyProperty RightButtonTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

UpButtonTemplateProperty

The object that defines visual representation of the up button. A DataTemplate representing up arrow symbol,is the default value.

Declaration

public static readonly DependencyProperty UpButtonTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

VerticalGripperTemplateProperty

The object that defines visual representation of the vertical grid splitter. A DataTemplate representing gripper symbol is the default value.

Declaration

public static readonly DependencyProperty VerticalGripperTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

DownButtonTemplate

Gets or sets the System.Windows.DataTemplate that defines the visual representation of the down button, which is used to perform expand and collapse operation horizontally.

Declaration

public DataTemplate DownButtonTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

Remarks

The DataContext of the DownButtonTemplate is inherited from SfGridSplitter

EnableCollapseButton

Gets or sets a value indicating whether the collapse/expand helper buttons are enabled on the splitter. When enabled, popups with arrow buttons appear near the splitter to quickly collapse or expand adjacent regions.

Declaration

public bool EnableCollapseButton { get; set; }

Property Value

Type
System.Boolean

HorizontalGripperTemplate

Gets or sets the System.Windows.DataTemplate that defines the visual representation of the gripper in horizontal grid splitter, which is used to perform resize.

Declaration

public DataTemplate HorizontalGripperTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

Remarks

The DataContext of the HorizontalGripperTemplate is inherited from SfGridSplitter

LeftButtonTemplate

Gets or sets the System.Windows.DataTemplate that defines the visual representation of the left button, which is used to perform expand and collapse operation vertically.

Declaration

public DataTemplate LeftButtonTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

Remarks

The DataContext of the LeftButtonTemplate is inherited from SfGridSplitter

RightButtonTemplate

Gets or sets the System.Windows.DataTemplate that defines the visual representation of the right button, which is used to perform expand and collapse operation vertically.

Declaration

public DataTemplate RightButtonTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

Remarks

The DataContext of the RightButtonTemplate is inherited from SfGridSplitter

UpButtonTemplate

Gets or sets the System.Windows.DataTemplate that defines the visual representation of the up button, which is used to perform expand and collapse operation horizontally.

Declaration

public DataTemplate UpButtonTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

Remarks

The DataContext of the UpButtonTemplate is inherited from SfGridSplitter

VerticalGripperTemplate

Gets or sets the System.Windows.DataTemplate that defines the visual representation of the gripper in vertical grid splitter, which is used to perform resize.

Declaration

public DataTemplate VerticalGripperTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

Remarks

The DataContext of the VerticalGripperTemplate is inherited from SfGridSplitter

Methods

Dispose()

Releases resources held by the control by detaching event handlers and clearing template part references.

Declaration

public void Dispose()

Remarks

Call this when the control is no longer needed to help the GC by breaking event-handler references. This method does not dispose unmanaged resources and is safe to call multiple times.

MoveSplitter(Double)

Move the splitter and resize the affected columns or rows.

Declaration

public void MoveSplitter(double Change)

Parameters

Type	Name	Description
System.Double	Change	Pixels to resize horizontally or vertically.

OnApplyTemplate()

Builds the visual tree for the System.Windows.Controls.SfGridSplitter control when a new template is applied.

Declaration

public override void OnApplyTemplate()

OnMouseLeave(MouseEventArgs)

Mouse leave from SfGridSplitter

Declaration

protected override void OnMouseLeave(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseEventArgs	e

OnMouseMove(MouseEventArgs)

Mouse move interaction on SfGridSplitter

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseEventArgs	e

OnPreviewMouseUp(MouseButtonEventArgs)

Preview mouse up from SfGridSplitter.

Declaration

protected override void OnPreviewMouseUp(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e

Implements

System.IDisposable