Class RadSplitter

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.

Inheritance
System.Object
RadControl
RadSplitter
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadSplitter : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadSplitter()

Initializes a new instance of the RadSplitter class.

Declaration
public RadSplitter()

Properties

AllowDrop

This property is not relevant for this class.

Declaration
public override bool AllowDrop { get; set; }
Property Value
System.Boolean

Anchor

This property is not relevant for this class.

Declaration
public override AnchorStyles Anchor { get; set; }
Property Value
System.Windows.Forms.AnchorStyles

BackgroundImage

This property is not relevant for this class.

Declaration
public override Image BackgroundImage { get; set; }
Property Value
System.Drawing.Image

BackgroundImageLayout

This property is not relevant for this class.

Declaration
public override ImageLayout BackgroundImageLayout { get; set; }
Property Value
System.Windows.Forms.ImageLayout

BorderStyle

Gets or sets the border style for the splitter control.

Declaration
public BorderStyle BorderStyle { get; set; }
Property Value
System.Windows.Forms.BorderStyle

CollapsedState

Gets the current collapsed state of the splitter.

Declaration
public SplitterCollapsedState CollapsedState { get; }
Property Value
SplitterCollapsedState

CreateParams

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

Declaration
protected override CreateParams CreateParams { get; }
Property Value
System.Windows.Forms.CreateParams

DefaultCursor

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

Declaration
protected override Cursor DefaultCursor { get; }
Property Value
System.Windows.Forms.Cursor

DefaultImeMode

Declaration
protected override ImeMode DefaultImeMode { get; }
Property Value
System.Windows.Forms.ImeMode

DefaultSize

Gets the default size for the splitter control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

Dock

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

Declaration
public override DockStyle Dock { get; set; }
Property Value
System.Windows.Forms.DockStyle

Font

This property is not relevant for this class.

Declaration
public override Font Font { get; set; }
Property Value
System.Drawing.Font

Overrides

ForeColor

This property is not relevant for this class.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

ImeMode

This property is not relevant for this class.

Declaration
public ImeMode ImeMode { get; set; }
Property Value
System.Windows.Forms.ImeMode

IsCollapsed

Gets a value indicating whether the splitter is currently collapsed.

Declaration
public bool IsCollapsed { get; }
Property Value
System.Boolean

MinExtra

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

Declaration
public int MinExtra { get; set; }
Property Value
System.Int32

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.

Declaration
public int MinSize { get; set; }
Property Value
System.Int32

SplitPosition

Gets or sets the position of the splitter bar.

Declaration
public int SplitPosition { get; set; }
Property Value
System.Int32

SplitterElement

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

Declaration
public SplitterElement SplitterElement { get; }
Property Value
SplitterElement

TabStop

This property is not relevant for this class.

Declaration
public bool TabStop { get; set; }
Property Value
System.Boolean

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

ThumbLength

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

Declaration
public int ThumbLength { get; set; }
Property Value
System.Int32

Methods

Collapse(SplitterCollapsedState)

Collapses the splitter to the specified state.

Declaration
public bool Collapse(SplitterCollapsedState target)
Parameters
SplitterCollapsedState target

The collapse state target.
Returns
System.Boolean

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
RadElement parent

The parent element to which child items are added.
Overrides

Expand()

Expands the splitter to its normal state.

Declaration
public bool Expand()
Returns
System.Boolean

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

OnHandleCreated(EventArgs)

Raises the HandleCreated event and initializes the splitter manager.

Declaration
protected override void OnHandleCreated(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnKeyDown(KeyEventArgs)

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

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

A System.Windows.Forms.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
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.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
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.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
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs that contains the event data.
Overrides

OnSplitterMoved(SplitterEventArgs)

Raises the SplitterMoved event.

Declaration
protected virtual void OnSplitterMoved(SplitterEventArgs sevent)
Parameters
System.Windows.Forms.SplitterEventArgs sevent

A System.Windows.Forms.SplitterEventArgs that contains the event data.

OnSplitterMoving(SplitterEventArgs)

Raises the SplitterMoving event.

Declaration
protected virtual void OnSplitterMoving(SplitterEventArgs sevent)
Parameters
System.Windows.Forms.SplitterEventArgs sevent

A System.Windows.Forms.SplitterEventArgs that contains the event data.

SetBoundsCore(Int32, Int32, Int32, Int32, 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
System.Int32 x

The new x-coordinate of the control.
System.Int32 y

The new y-coordinate of the control.
System.Int32 width

The new width of the control.
System.Int32 height

The new height of the control.
System.Windows.Forms.BoundsSpecified specified

A bitwise combination of the System.Windows.Forms.BoundsSpecified values.
Overrides

ThumbHitTest(Point)

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

Declaration
public bool ThumbHitTest(Point pt)
Parameters
System.Drawing.Point pt

The point to test.
Returns
System.Boolean

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

ToString()

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

Declaration
public override string ToString()
Returns
System.String

A string representation of the splitter.

Events

BackgroundImageChanged

This event is not relevant for this class.

Declaration
public event EventHandler BackgroundImageChanged
Event Type
System.EventHandler

BackgroundImageLayoutChanged

This event is not relevant for this class.

Declaration
public event EventHandler BackgroundImageLayoutChanged
Event Type
System.EventHandler

Enter

This event is not relevant for this class.

Declaration
public event EventHandler Enter
Event Type
System.EventHandler

FontChanged

This event is not relevant for this class.

Declaration
public event EventHandler FontChanged
Event Type
System.EventHandler

ForeColorChanged

This event is not relevant for this class.

Declaration
public event EventHandler ForeColorChanged
Event Type
System.EventHandler

ImeModeChanged

This event is not relevant for this class.

Declaration
public event EventHandler ImeModeChanged
Event Type
System.EventHandler

KeyDown

This event is not relevant for this class.

Declaration
public event KeyEventHandler KeyDown
Event Type
System.Windows.Forms.KeyEventHandler

KeyPress

This event is not relevant for this class.

Declaration
public event KeyPressEventHandler KeyPress
Event Type
System.Windows.Forms.KeyPressEventHandler

KeyUp

This event is not relevant for this class.

Declaration
public event KeyEventHandler KeyUp
Event Type
System.Windows.Forms.KeyEventHandler

Leave

This event is not relevant for this class.

Declaration
public event EventHandler Leave
Event Type
System.EventHandler

SplitterMoved

Occurs when the splitter control is moved.

Declaration
public event SplitterEventHandler SplitterMoved
Event Type
System.Windows.Forms.SplitterEventHandler

SplitterMoving

Occurs when the splitter control is moving.

Declaration
public event SplitterEventHandler SplitterMoving
Event Type
System.Windows.Forms.SplitterEventHandler

TabStopChanged

This event is not relevant for this class.

Declaration
public event EventHandler TabStopChanged
Event Type
System.EventHandler

TextChanged

This event is not relevant for this class.

Declaration
public event EventHandler TextChanged
Event Type
System.EventHandler

Extension Methods