Class RadSplitContainer

Inheritance
System.Object
RadControl
SplitPanel
RadSplitContainer
DocumentContainer
RadDock
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Containers")]
[RadToolboxItem(false)]
public class RadSplitContainer : SplitPanel, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadSplitContainer()

Declaration
public RadSplitContainer()

RadSplitContainer(Orientation)

Declaration
public RadSplitContainer(Orientation orientation)
Parameters
System.Windows.Forms.Orientation orientation

Properties

AutoSize

Gets or sets whether the edit control is auto-sized

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

Overrides

ContentRectangle

Declaration
public virtual Rectangle ContentRectangle { get; }
Property Value
System.Drawing.Rectangle

Cursor

Gets or sets the cursor that is displayed when the mouse pointer is over the control.

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

EnableCollapsing

Determines whether the panels can be collapsed when clicking twice on splitter or click once on navigation button. If you disable collapsing, UseSplitterButtons will also be disabled.

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

EnableImmediateResize

Gets a value indicating whether the bounds of the split panels should be updated immediately on drag.

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

ForeColor

This property is not relevant for this class.

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

Overrides

HasNonCollapsedChild

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

HasVisibleSplitPanels

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

HorizontalResizeCursor

Gets or sets the cursor which is used while resizing a panel and the control`s orientation is horizontal.

Declaration
public virtual Cursor HorizontalResizeCursor { get; set; }
Property Value
System.Windows.Forms.Cursor

IsCleanUpTarget

Determines whether the container is a target of automatic defragment operation. This property is internally used by the framework and is not intended to be directly used in code.

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

LayoutStrategy

Gets or sets the layout strategy that arranges all the visible SplitPanel children.

Declaration
public SplitContainerLayoutStrategy LayoutStrategy { get; set; }
Property Value
SplitContainerLayoutStrategy

NavigationButtonCursor

Gets or sets the cursor which is used while the mouse is over the navigation buttons.

Declaration
public virtual Cursor NavigationButtonCursor { get; set; }
Property Value
System.Windows.Forms.Cursor

Orientation

Gets or sets a value indicating the horizontal or vertical orientation of the Telerik.WinControls.UI.RadSplitContainer panels.

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

RootContainer

Declaration
public RadSplitContainer RootContainer { get; }
Property Value
RadSplitContainer

SplitContainerElement

Gets the split container element.

Declaration
public SplitContainerElement SplitContainerElement { get; }
Property Value
SplitContainerElement

SplitPanels

Declaration
public SplitPanelCollection SplitPanels { get; }
Property Value
SplitPanelCollection

SplitterDistance

Gets a value indicating the splitter distance. Never set the value of this property directly.

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

Splitters

Declaration
public SplitterCollection Splitters { get; }
Property Value
SplitterCollection

SplitterWidth

Gets or sets the width of a single splitter on the container. Specify zero to prevent displaying any splitters at all.

Declaration
[RadPropertyDefaultValue("SplitterWidth", typeof(SplitContainerElement))]
public virtual int SplitterWidth { get; set; }
Property Value
System.Int32

Text

This property is not relevant for this class.

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

Overrides

ThemeClassName

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

Overrides

UseSplitterButtons

Enable and Disable navigation buttons. If you enable the buttons EnableCollapsing will also be enabled.

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

VerticalResizeCursor

Gets or sets the cursor which is used while resizing a panel and the control`s orientation is vertical.

Declaration
public virtual Cursor VerticalResizeCursor { get; set; }
Property Value
System.Windows.Forms.Cursor

Methods

ApplySplitterWidth(Int32)

Applies the desired splitter width across all splitters and delegates the event to all descendant RadSplitContainer instances. This method is used internally.

Declaration
public virtual void ApplySplitterWidth(int splitterWidth)
Parameters
System.Int32 splitterWidth

ApplyThemeToSplitterElements()

Applies theme to all SplitterElements.

Declaration
protected virtual void ApplyThemeToSplitterElements()

CalculateSplitterDistance(RadDirection, Int32, Int32, Int32, Int32)

Declaration
protected virtual void CalculateSplitterDistance(RadDirection direction, int initialSplitterDistance, int lastSplitterPosition, int boundsMinimum, int boundsMaximum)
Parameters
RadDirection direction

System.Int32 initialSplitterDistance

System.Int32 lastSplitterPosition

System.Int32 boundsMinimum

System.Int32 boundsMaximum

CanSelectAtDesignTime()

Determines whether the container can be selected at design-time. This method is used internally.

Declaration
public virtual bool CanSelectAtDesignTime()
Returns
System.Boolean

Construct()

Declaration
protected override void Construct()
Overrides

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

CreateControlsInstance()

Declaration
protected override Control.ControlCollection CreateControlsInstance()
Returns
System.Windows.Forms.Control.ControlCollection

GetSplitterElementAndButtonElementAtPoint(Point, out SplitterElement, out RadButtonElement)

Gets SplitterElement and RadButtonElement whose rectangles contain the specified Point.

clientPoint is the Point to test, in SplitContainer client coordinates. splitter and button are the output SplitterElement and RadButtonElement.

Declaration
public virtual void GetSplitterElementAndButtonElementAtPoint(Point clientPoint, out SplitterElement splitter, out RadButtonElement button)
Parameters
System.Drawing.Point clientPoint

SplitterElement splitter

RadButtonElement button

GetSplitterElementAtPoint(Point)

Gets SplitterElement which rectangle conttains the specified Point.

Declaration
public virtual SplitterElement GetSplitterElementAtPoint(Point clientPoint)
Parameters
System.Drawing.Point clientPoint

Point to test, in SplitContainer client coordinates.
Returns
SplitterElement

SplitterElement if found, null otherwise

LayoutInternal()

Declaration
protected void LayoutInternal()

MergeWithParentContainer()

Provides a routine which merges a container with its parent (if appropriate). The purpose of this logic is to remove internally created containers when they are not needed. This method is used internally.

Declaration
public virtual bool MergeWithParentContainer()
Returns
System.Boolean

MoveSplitter(SplitterElement, RadDirection)

Declaration
public void MoveSplitter(SplitterElement splitter, RadDirection direction)
Parameters
SplitterElement splitter

RadDirection direction

OnChildPanelCollapsedChanged(SplitPanel)

Declaration
protected virtual void OnChildPanelCollapsedChanged(SplitPanel child)
Parameters
SplitPanel child

OnControlRemoved(ControlEventArgs)

Declaration
protected override void OnControlRemoved(ControlEventArgs e)
Parameters
System.Windows.Forms.ControlEventArgs e

Overrides

OnLayout(LayoutEventArgs)

Declaration
protected override void OnLayout(LayoutEventArgs e)
Parameters
System.Windows.Forms.LayoutEventArgs e

Overrides

OnLoad(Size)

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

Overrides

OnMouseDoubleClick(MouseEventArgs)

Declaration
protected override void OnMouseDoubleClick(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

OnMouseDown(MouseEventArgs)

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseLeave(EventArgs)

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

Overrides

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseUp(MouseEventArgs)

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnNavigationButtonClick(Object, EventArgs)

Declaration
protected virtual void OnNavigationButtonClick(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

OnOrientationChanged(EventArgs)

Declaration
protected virtual void OnOrientationChanged(EventArgs e)
Parameters
System.EventArgs e

OnPanelCollapsed(SplitterElement, EventArgs)

Declaration
public virtual void OnPanelCollapsed(SplitterElement splitter, EventArgs e)
Parameters
SplitterElement splitter

System.EventArgs e

OnPanelCollapsing(SplitterElement, RadSplitContainer.PanelCollapsingEventArgs)

Declaration
public virtual void OnPanelCollapsing(SplitterElement splitter, RadSplitContainer.PanelCollapsingEventArgs e)
Parameters
SplitterElement splitter

RadSplitContainer.PanelCollapsingEventArgs e

OnParentChanged(EventArgs)

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

Overrides

OnSplitterMoved(SplitterEventArgs)

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

OnSplitterMoving(SplitterCancelEventArgs)

Declaration
protected virtual void OnSplitterMoving(SplitterCancelEventArgs e)
Parameters
System.Windows.Forms.SplitterCancelEventArgs e

OnThemeChanged()

Declaration
protected override void OnThemeChanged()
Overrides

ResetBackColorThemeOverrides()

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

RestoreSplitterPosition(SplitterElement)

Declaration
public void RestoreSplitterPosition(SplitterElement splitter)
Parameters
SplitterElement splitter

SetBackColorThemeOverrides()

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

UpdateCollapsed()

this method is used internally.

Declaration
public virtual void UpdateCollapsed()

UpdateSplitter(SplitContainerLayoutInfo, Int32, Rectangle)

Updates the splitter, associated with the specified index of a child SplitPanel.

Declaration
protected virtual void UpdateSplitter(SplitContainerLayoutInfo info, int panelIndex, Rectangle bounds)
Parameters
SplitContainerLayoutInfo info

The layout info, containing information about the operation.
System.Int32 panelIndex

The index of the panel for which the splitter should be updated.
System.Drawing.Rectangle bounds

The bounding rectangle of the splitter.

Events

PanelCollapsed

Occurs when some panel collapsed.

Declaration
public event RadSplitContainer.PanelCollapsedEventHandler PanelCollapsed
Event Type
RadSplitContainer.PanelCollapsedEventHandler

PanelCollapsedChanged

Declaration
public event SplitPanelEventHandler PanelCollapsedChanged
Event Type
SplitPanelEventHandler

PanelCollapsing

Occurs when some panel is collapsing.

Declaration
public event RadSplitContainer.PanelCollapsingEventHandler PanelCollapsing
Event Type
RadSplitContainer.PanelCollapsingEventHandler

SplitterMoved

Occurs when any of the splitters is moved.

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

SplitterMoving

Occurs when any of the splitters is moving.

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

Extension Methods