New to Telerik UI for WinFormsStart a free 30-day trial

Represents a splitter control that provides a resizable divider between controls. The splitter allows users to resize adjacent controls by dragging the splitter bar, and provides collapse/expand functionality through navigation buttons.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class RadSplitter : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadSplitter...

Implements: IAnalyticsProviderIBindableComponentIComponentIComponentTreeHandlerIDisposableIDropTargetILayoutHandlerINotifyPropertyChangedISupportInitializeISupportInitializeNotificationISynchronizeInvokeIWin32Window...

Inherited Members RadControl.isResizing2RadControl.isDisposing2RadControl.invalidResizeRectRadControl.isAccessibilityRequestedRadControl.Dispose(bool)RadControl.Construct()RadControl.CreateBehavior()RadControl.CreateRootElement()RadControl.InitializeRootElement(RootRadElement)RadControl.LoadElementTree()RadControl.LoadElementTree(Size)RadControl.SetBackColorThemeOverrides()RadControl.ResetBackColorThemeOverrides()RadControl.SetForeColorThemeOverrides()RadControl.ResetForeColorThemeOverrides()RadControl.OnKeyUp(KeyEventArgs)RadControl.OnPreviewKeyDown(PreviewKeyDownEventArgs)RadControl.OnKeyPress(KeyPressEventArgs)RadControl.OnClick(EventArgs)RadControl.OnDoubleClick(EventArgs)RadControl.OnMouseEnter(EventArgs)RadControl.OnMouseLeave(EventArgs)RadControl.OnMouseHover(EventArgs)RadControl.OnMouseWheel(MouseEventArgs)RadControl.OnMouseCaptureChanged(EventArgs)RadControl.OnGotFocus(EventArgs)RadControl.OnLostFocus(EventArgs)RadControl.OnCreateControl()RadControl.OnHandleDestroyed(EventArgs)RadControl.OnParentChanged(EventArgs)RadControl.OnVisibleChanged(EventArgs)RadControl.OnFontChanged(EventArgs)RadControl.OnForeColorChanged(EventArgs)RadControl.OnBackColorChanged(EventArgs)RadControl.OnEnabledChanged(EventArgs)RadControl.OnBindingContextChanged(EventArgs)RadControl.OnLocationChanged(EventArgs)RadControl.OnPaddingChanged(EventArgs)RadControl.OnRightToLeftChanged(EventArgs)RadControl.OnPaint(PaintEventArgs)RadControl.OnLayout(LayoutEventArgs)RadControl.OnAutoSizeChanged(EventArgs)RadControl.WndProc(ref Message)RadControl.OnInvalidated(RadElement)RadControl.OnLoad(Size)RadControl.OnCaptureLosing()RadControl.OnThemeChanged()RadControl.OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)RadControl.OnScreenTipNeeded(object, ScreenTipNeededEventArgs)RadControl.OnThemeNameChanged(ThemeNameChangedEventArgs)RadControl.ProcessMnemonic(char)RadControl.ProcessFocusRequested(RadElement)RadControl.ProcessCaptureChangeRequested(RadElement, bool)RadControl.ProcessAutoSizeChanged(bool)RadControl.IsInputKey(Keys)RadControl.GetInputElement()RadControl.BeginInit()RadControl.EndInit()RadControl.OnNotifyPropertyChanged(string)RadControl.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadControl.GetPreferredSize(Size)RadControl.GetRootElementDesiredSize(int, int, int, int)RadControl.OnZoomGesture(ZoomGestureEventArgs)RadControl.OnRotateGesture(RotateGestureEventArgs)RadControl.OnPanGesture(PanGestureEventArgs)RadControl.OnTwoFingerTapGesture(GestureEventArgs)RadControl.OnPressAndTapGesture(PressAndTapGestureEventArgs)RadControl.OnGesture(GestureEventArgs)RadControl.ProcessGesture(Message)RadControl.EnableGesture(GestureType)RadControl.DisableGesture(GestureType)RadControl.Refresh()RadControl.SuspendUpdate()RadControl.ResumeUpdate()RadControl.ResumeUpdate(bool)RadControl.InvokeLayoutCallback(LayoutCallback)RadControl.RegisterHostedControl(RadHostItem)RadControl.UnregisterHostedControl(RadHostItem, bool)RadControl.ResolveStyleGroupForElement(StyleGroup, RadObject)RadControl.GetPlainText()RadControl.ShouldSerializeProperty(RadProperty)RadControl.ShouldSerializeProperty(RadProperty, RadObject)RadControl.ResetProperty(RadProperty, RadObject)RadControl.CanEditElementAtDesignTime(RadElement)RadControl.ProcessCodedUIMessage(ref IPCMessage)RadControl.FindPropertyInChildren(RadControl, IPCMessage)RadControl.ScaleControl(SizeF, BoundsSpecified)RadControl.PerformRadAutoScale(BoundsSpecified?)RadControl.GetMonitorDpiScaleFactor(Control)RadControl.SetRadAutoScale(bool)RadControl.EnableDpiScalingRadControl.EnableRadAutoScaleRadControl.EnableRadFormInitialDpiScalingRadControl.EnableImageDpiScalingRadControl.EnableSvgImagesRadControl.IsLoadedRadControl.ElementTreeRadControl.UseCompatibleTextRenderingDefaultValueRadControl.BehaviorRadControl.RootElementRadControl.PaddingRadControl.ThemeNameRadControl.TextRadControl.EnableThemingRadControl.ThemeClassNameRadControl.ImageListRadControl.ImageScalingSizeRadControl.UseCompatibleTextRenderingRadControl.AutoSizeRadControl.MaximumSizeRadControl.MinimumSizeRadControl.FocusableRadControl.SiteRadControl.CausesValidationRadControl.IsInitializingRadControl.SmallImageListRadControl.SmallImageScalingSizeRadControl.IsDesignModeRadControl.IsDisplayedRadControl.FocusedElementRadControl.AllowShowFocusCuesRadControl.ShowItemToolTipsRadControl.CommandBindingsRadControl.EnableKeyMapRadControl.BackColorRadControl.ForeColorRadControl.FontRadControl.ValidationCancelRadControl.EnableAnalyticsRadControl.AnalyticsNameRadControl.EnableRadAccessibilityObjectsRadControl.EnableCodedUITestsRadControl.EnableCodedUITestsDefaultValueRadControl.EnableUIAutomationRadControl.EnableUIAutomationDefaultValueRadControl.ElementInvalidatedRadControl.ToolTipTextNeededRadControl.ScreenTipNeededRadControl.ThemeNameChangedRadControl.InitializedRadControl.PropertyChangedRadControl.ZoomGestureRadControl.RotateGestureRadControl.PanGestureRadControl.TwoFingerTapGestureRadControl.PressAndTapGesture...

Constructors

Initializes a new instance of the RadSplitter class.

C#
public RadSplitter()

Properties

Gets or sets the border style for the splitter control.

C#
public BorderStyle BorderStyle { get; set; }

Gets the current collapsed state of the splitter.

C#
public SplitterCollapsedState CollapsedState { get; }

Gets the required creation parameters when the control handle is created.

C#
protected override CreateParams CreateParams { get; }

Overrides: ScrollableControl.CreateParams

Gets the default cursor for the splitter based on its dock position.

C#
protected override Cursor DefaultCursor { get; }

Overrides: Control.DefaultCursor

C#
protected override ImeMode DefaultImeMode { get; }

Overrides: Control.DefaultImeMode

Gets the default size for the splitter control.

C#
protected override Size DefaultSize { get; }

Overrides: Control.DefaultSize

Gets or sets which side of the parent container the control is docked to.

C#
public override DockStyle Dock { get; set; }

Overrides: Control.Dock

Gets a value indicating whether the splitter is currently collapsed.

C#
public bool IsCollapsed { get; }

Gets or sets the minimum distance that must remain between the splitter control and the container edge that the control is docked to.

C#
public int MinExtra { get; set; }

Gets or sets the minimum distance that must remain between the splitter control and the container edge opposite to the edge the control is docked to.

C#
public int MinSize { get; set; }

Gets or sets the position of the splitter bar.

C#
[Browsable(false)]
public int SplitPosition { get; set; }

Gets the splitter element that represents the visual element of the splitter.

C#
[Browsable(false)]
public SplitterElement SplitterElement { get; }

Gets or sets the length of the splitter thumb in pixels.

C#
public int ThumbLength { get; set; }

Methods

Collapses the splitter to the specified state.

C#
public bool Collapse(SplitterCollapsedState target)
Parameters:targetSplitterCollapsedState

The collapse state target.

Returns:

bool

True if the splitter was successfully collapsed; otherwise, false.

Creates the child items for the splitter control and initializes the splitter element.

C#
protected override void CreateChildItems(RadElement parent)
Parameters:parentRadElement

The parent element to which child items are added.

Overrides: RadControl.CreateChildItems(RadElement)

Expands the splitter to its normal state.

C#
public bool Expand()
Returns:

bool

True if the splitter was successfully expanded; otherwise, false.

Raises the HandleCreated event and initializes the splitter manager.

C#
protected override void OnHandleCreated(EventArgs e)
Parameters:eEventArgs

An EventArgs that contains the event data.

Overrides: Control.OnHandleCreated(EventArgs)

Raises the KeyDown event and handles escape key to end splitter operations.

C#
protected override void OnKeyDown(KeyEventArgs e)
Parameters:eKeyEventArgs

A KeyEventArgs that contains the event data.

Overrides: RadControl.OnKeyDown(KeyEventArgs)

Raises the MouseDown event and initiates splitter operations when appropriate.

C#
protected override void OnMouseDown(MouseEventArgs e)
Parameters:eMouseEventArgs

A MouseEventArgs that contains the event data.

Overrides: RadControl.OnMouseDown(MouseEventArgs)

Raises the MouseMove event and handles splitter movement operations.

C#
protected override void OnMouseMove(MouseEventArgs e)
Parameters:eMouseEventArgs

A MouseEventArgs that contains the event data.

Overrides: RadControl.OnMouseMove(MouseEventArgs)

Raises the MouseUp event and handles splitter collapse/expand operations.

C#
protected override void OnMouseUp(MouseEventArgs e)
Parameters:eMouseEventArgs

A MouseEventArgs that contains the event data.

Overrides: RadControl.OnMouseUp(MouseEventArgs)

Raises the SplitterMoved event.

C#
protected virtual void OnSplitterMoved(SplitterEventArgs sevent)
Parameters:seventSplitterEventArgs

A SplitterEventArgs that contains the event data.

Raises the SplitterMoving event.

C#
protected virtual void OnSplitterMoving(SplitterEventArgs sevent)
Parameters:seventSplitterEventArgs

A SplitterEventArgs that contains the event data.

Sets the bounds of the control and adjusts the splitter thickness accordingly.

C#
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters:xint

The new x-coordinate of the control.

yint

The new y-coordinate of the control.

widthint

The new width of the control.

heightint

The new height of the control.

specifiedBoundsSpecified

A bitwise combination of the BoundsSpecified values.

Overrides: RadControl.SetBoundsCore(int, int, int, int, BoundsSpecified)

Determines whether the specified point is within the splitter thumb area.

C#
public bool ThumbHitTest(Point pt)
Parameters:ptPoint

The point to test.

Returns:

bool

True if the point is within the thumb area; otherwise, false.

Returns a string that represents the current splitter, including its minimum extra space and minimum size.

C#
public override string ToString()
Returns:

string

A string representation of the splitter.

Overrides: Component.ToString()

Events

Occurs when the splitter control is moved.

C#
public event SplitterEventHandler SplitterMoved

Occurs when the splitter control is moving.

C#
public event SplitterEventHandler SplitterMoving