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

Represents a split container that can hold multiple items in a resizable layout. The RadSplitContainer can be oriented either horizontally or vertically, allowing for flexible layouts in user interfaces. It supports docking of child items and includes functionality for managing the visibility and arrangement of its child components. This class also implements several interfaces for enhanced behavior in document hosts and tool windows, providing theming capabilities and supporting resize operations.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Docking.dll

Syntax:

C#
[TelerikToolboxCategory("Containers")]
public class RadSplitContainer : ItemsControl, ISplitItem

Inheritance: objectRadSplitContainer

Implements: ISplitItem

Constructors

Initializes a new instance of the RadSplitContainer class.

C#
public RadSplitContainer()

Fields

InitialPositionProperty

DependencyProperty

Identifies the InitialPosition dependency property.

C#
public static readonly DependencyProperty InitialPositionProperty

OrientationProperty

DependencyProperty

Identifies the OrientationProperty dependency property.

C#
public static readonly DependencyProperty OrientationProperty

SplitterPositionProperty

DependencyProperty

Identifies the ResizerPosition property.

C#
public static readonly DependencyProperty SplitterPositionProperty

Properties

Control

Control

Gets the actual control that will be a visual child of the SplitContainer.

C#
public Control Control { get; }

Implements: ISplitItem.Control

Gets or sets the initial position.

C#
public DockState InitialPosition { get; set; }
Property Value:

The initial position.

Gets a value indicating whether the object is contained within a DocumentHost.

C#
public bool IsInDocumentHost { get; }

Gets a value indicating whether the object is contained within a ToolWindow.

C#
public bool IsInToolWindow { get; }

Orientation

Orientation

Gets or sets the orientation.

C#
public Orientation Orientation { get; set; }
Property Value:

The orientation.

Gets or sets the SplitContainer that holds the item.

C#
public RadSplitContainer ParentContainer { get; }
Property Value:

The RadSplitContainer that contains the split container.

Implements: ISplitItem.ParentContainer

Gets the position of the Resizer in the RadSplitContainer template.

C#
public Dock? SplitterPosition { get; }

Methods

Adds the item relative to another item.

C#
public void AddItem(ISplitItem item, DockPosition dockPosition, ISplitItem relativeTo)
Parameters:itemISplitItem

The item to be added.

dockPositionDockPosition

The relative position at which the item will be added.

relativeToISplitItem

The item, relative to which the new one will be added.

Updates the visual states of the control.

C#
protected virtual void ChangeVisualState(bool useTransitions)
Parameters:useTransitionsbool

Identifies whether the transitions should be used.

Clears the container for item override.

C#
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters:elementDependencyObject

The element.

itemobject

The item.

Enumerates the panes contained by the split item and its children.

C#
public IEnumerable<RadPane> EnumeratePanes()
Returns:

IEnumerable<RadPane>

Implements: ISplitItem.EnumeratePanes()

Gets the container for item override.

C#
protected override DependencyObject GetContainerForItemOverride()
Returns:

DependencyObject

Ready for use container.

Attempts to move the control to one of the states in the list.

C#
protected void GoToState(bool useTransitions, params string[] stateNames)
Parameters:useTransitionsbool

Indicates whether transitions should be used.

stateNamesstring[]

The names of the states that should be reached.

Determines whether is the specified item its own container.

C#
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters:itemobject

The item.

Returns:

bool

True if the specified item is its own container; otherwise, false.

When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate().

C#
public override void OnApplyTemplate()
C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

Raises the event and sets from the active theme.

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

The RoutedEventArgs that contains the event data.

Called when the IsInDocumentHost property changes. Allows the control to change its appearance and behavior when placed in a DocumentHost.

C#
protected virtual void OnIsInDocumentHostChanged(bool oldValue, bool newValue)
Parameters:oldValuebool

The old value of the property.

newValuebool

The new value of the property.

Called when the IToolWindowAware property changes. Allows the control to change its appearance and behavior when placed in a ToolWindow.

C#
protected virtual void OnIsInToolWindowChanged(bool oldValue, bool newValue)
Parameters:oldValuebool

The old value of the property.

newValuebool

The new value of the property.

Raises the event.

C#
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters:eNotifyCollectionChangedEventArgs

The NotifyCollectionChangedEventArgs instance containing the event data.

Called when the event is fired.

C#
protected virtual void OnLoaded(object sender, RoutedEventArgs e)
Parameters:senderobject

The sender.

eRoutedEventArgs

The RoutedEventArgs instance containing the event data.

Prepares the container for item override.

C#
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters:elementDependencyObject

The element.

itemobject

The item.

Resets the theme.

C#
public void ResetTheme()