GridSplitter Class

Definition

Namespace:: CommunityToolkit.WinUI.Controls

Assembly:: CommunityToolkit.WinUI.Controls.Sizers.dll

Package:: CommunityToolkit.WinUI.Controls.Sizers v8.2.250402

Source:: GridSplitter.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents the control that redistributes space between columns or rows of a Grid control.

public class GridSplitter : CommunityToolkit.WinUI.Controls.SizerBase

type GridSplitter = class
    inherit SizerBase

Public Class GridSplitter
Inherits SizerBase

Inheritance: Microsoft.UI.Xaml.Controls.Control

SizerBase
GridSplitter

Constructors

Name	Description
GridSplitter()

Fields

Name	Description
ParentLevelProperty	Identifies the ParentLevel dependency property.
ResizeBehaviorProperty	Identifies the ResizeBehavior dependency property.
ResizeDirectionProperty	Identifies the ResizeDirection dependency property.

Properties

Name	Description
Cursor	Gets or sets the cursor to use when hovering over the gripper bar. If left as `null`, the control will manage the cursor automatically based on the Orientation property value (default). (Inherited from SizerBase)
DragIncrement	Gets or sets the incremental amount of change for dragging with the mouse or touch of a sizer control. Effectively a snapping increment for changes. The default is 1. (Inherited from SizerBase)
IsThumbVisible	Gets or sets if the Thumb is visible. If not visible, only the background and cursor will be shown on MouseOver or Pressed states. (Inherited from SizerBase)
KeyboardIncrement	Gets or sets the distance each press of an arrow key moves a sizer control. The default is 8. (Inherited from SizerBase)
Orientation	Gets or sets the orientation the sizer will be and how it will interact with other elements. Defaults to Microsoft.UI.Xaml.Controls.Orientation.Vertical. (Inherited from SizerBase)
ParentLevel	Gets or sets the level of the parent grid to resize
ResizeBehavior	Gets or sets which Columns or Rows the Splitter resizes.
ResizeDirection	Gets or sets whether the Splitter resizes the Columns, Rows, or Both.

Methods

Name	Description
OnApplyTemplate()	(Inherited from SizerBase)
OnCreateAutomationPeer()	Creates AutomationPeer (Microsoft.UI.Xaml.UIElement.OnCreateAutomationPeer) (Inherited from SizerBase)
OnDragHorizontal(Double)	Method to process the requested horizontal resize.
OnDragStarting()	Called when the SizerBase control starts to be dragged by the user. Implementer should record current state of manipulated target at this point in time. They will receive the cumulative change in OnDragHorizontal(Double) or OnDragVertical(Double) based on the Orientation property.
OnDragVertical(Double)	Method to process the requested vertical resize.
OnKeyDown(KeyRoutedEventArgs)	(Inherited from SizerBase)
OnLoaded(RoutedEventArgs)	Called when the control has been initialized.
OnManipulationDelta(ManipulationDeltaRoutedEventArgs)	(Inherited from SizerBase)
OnManipulationStarting(ManipulationStartingRoutedEventArgs)	(Inherited from SizerBase)

Applies to