ClassRadSplitter
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:
public class RadSplitter : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadSplitter
Implements:
Inherited Members
Constructors
RadSplitter()
Initializes a new instance of the RadSplitter class.
Declaration
public RadSplitter()Properties
BorderStyle
Gets or sets the border style for the splitter control.
Declaration
public BorderStyle BorderStyle { get; set; }Property Value
CollapsedState
Gets the current collapsed state of the splitter.
Declaration
public SplitterCollapsedState CollapsedState { get; }Property Value
CreateParams
Gets the required creation parameters when the control handle is created.
Declaration
protected override CreateParams CreateParams { get; }Property Value
Overrides
DefaultCursor
Gets the default cursor for the splitter based on its dock position.
Declaration
protected override Cursor DefaultCursor { get; }Property Value
Overrides
DefaultImeMode
Declaration
protected override ImeMode DefaultImeMode { get; }Property Value
Overrides
DefaultSize
Gets the default size for the splitter control.
Declaration
protected override Size DefaultSize { get; }Property Value
Overrides
Dock
Gets or sets which side of the parent container the control is docked to.
Declaration
public override DockStyle Dock { get; set; }Property Value
Overrides
IsCollapsed
Gets a value indicating whether the splitter is currently collapsed.
MinExtra
Gets or sets the minimum distance that must remain between the splitter control and the container edge that the control is docked to.
MinSize
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.
SplitPosition
Gets or sets the position of the splitter bar.
Declaration
[Browsable(false)]
public int SplitPosition { get; set; }Property Value
SplitterElement
Gets the splitter element that represents the visual element of the splitter.
Declaration
[Browsable(false)]
public SplitterElement SplitterElement { get; }Property Value
ThumbLength
Gets or sets the length of the splitter thumb in pixels.
Methods
Collapse(SplitterCollapsedState)
Collapses the splitter to the specified state.
Declaration
public bool Collapse(SplitterCollapsedState target)Parameters
target
The collapse state target.
Returns
True if the splitter was successfully collapsed; otherwise, false.
CreateChildItems(RadElement)
Creates the child items for the splitter control and initializes the splitter element.
Declaration
protected override void CreateChildItems(RadElement parent)Parameters
parent
The parent element to which child items are added.
Overrides
Expand()
Expands the splitter to its normal state.
Declaration
public bool Expand()Returns
True if the splitter was successfully expanded; otherwise, false.
OnHandleCreated(EventArgs)
Raises the HandleCreated event and initializes the splitter manager.
OnKeyDown(KeyEventArgs)
Raises the KeyDown event and handles escape key to end splitter operations.
Declaration
protected override void OnKeyDown(KeyEventArgs e)Parameters
e
A KeyEventArgs that contains the event data.
Overrides
OnMouseDown(MouseEventArgs)
Raises the MouseDown event and initiates splitter operations when appropriate.
Declaration
protected override void OnMouseDown(MouseEventArgs e)Parameters
e
A MouseEventArgs that contains the event data.
Overrides
OnMouseMove(MouseEventArgs)
Raises the MouseMove event and handles splitter movement operations.
Declaration
protected override void OnMouseMove(MouseEventArgs e)Parameters
e
A MouseEventArgs that contains the event data.
Overrides
OnMouseUp(MouseEventArgs)
Raises the MouseUp event and handles splitter collapse/expand operations.
Declaration
protected override void OnMouseUp(MouseEventArgs e)Parameters
e
A MouseEventArgs that contains the event data.
Overrides
OnSplitterMoved(SplitterEventArgs)
Raises the SplitterMoved event.
Declaration
protected virtual void OnSplitterMoved(SplitterEventArgs sevent)Parameters
sevent
A SplitterEventArgs that contains the event data.
OnSplitterMoving(SplitterEventArgs)
Raises the SplitterMoving event.
Declaration
protected virtual void OnSplitterMoving(SplitterEventArgs sevent)Parameters
sevent
A SplitterEventArgs that contains the event data.
SetBoundsCore(int, int, int, int, BoundsSpecified)
Sets the bounds of the control and adjusts the splitter thickness accordingly.
Declaration
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)Parameters
x
The new x-coordinate of the control.
y
The new y-coordinate of the control.
width
The new width of the control.
height
The new height of the control.
specified
A bitwise combination of the BoundsSpecified values.
Overrides
ThumbHitTest(Point)
Determines whether the specified point is within the splitter thumb area.
ToString()
Returns a string that represents the current splitter, including its minimum extra space and minimum size.
Declaration
public override string ToString()Returns
A string representation of the splitter.
Overrides
Events
SplitterMoved
Occurs when the splitter control is moved.
Declaration
public event SplitterEventHandler SplitterMovedEvent Value
SplitterMoving
Occurs when the splitter control is moving.
Declaration
public event SplitterEventHandler SplitterMovingEvent Value