Class
RadSplitContainer

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:

cs-api-definition
[TelerikToolboxCategory("Containers")]
public class RadSplitContainer : ItemsControl, ISplitItem

Inheritance: objectRadSplitContainer

Implements: ISplitItem

Constructors

RadSplitContainer()

Initializes a new instance of the RadSplitContainer class.

Declaration

cs-api-definition
public RadSplitContainer()

Fields

InitialPositionProperty

Identifies the InitialPosition dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty InitialPositionProperty

Field Value

DependencyProperty

OrientationProperty

Identifies the OrientationProperty dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty OrientationProperty

Field Value

DependencyProperty

SplitterPositionProperty

Identifies the ResizerPosition property.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Resizer")]
public static readonly DependencyProperty SplitterPositionProperty

Field Value

DependencyProperty

Properties

Control

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

Declaration

cs-api-definition
public Control Control { get; }

Property Value

Control

Implements ISplitItem.Control

InitialPosition

Gets or sets the initial position.

Declaration

cs-api-definition
public DockState InitialPosition { get; set; }

Property Value

DockState

The initial position.

IsInDocumentHost

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

Declaration

cs-api-definition
public bool IsInDocumentHost { get; }

Property Value

bool

IsInToolWindow

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

Declaration

cs-api-definition
public bool IsInToolWindow { get; }

Property Value

bool

Orientation

Gets or sets the orientation.

Declaration

cs-api-definition
public Orientation Orientation { get; set; }

Property Value

Orientation

The orientation.

ParentContainer

Gets or sets the SplitContainer that holds the item.

Declaration

cs-api-definition
public RadSplitContainer ParentContainer { get; }

Property Value

RadSplitContainer

The RadSplitContainer that contains the split container.

Implements ISplitItem.ParentContainer

SplitterPosition

Gets the position of the Resizer in the RadSplitContainer template.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Resizer")]
public Dock? SplitterPosition { get; }

Property Value

Dock?

Methods

AddItem(ISplitItem, DockPosition, ISplitItem)

Adds the item relative to another item.

Declaration

cs-api-definition
public void AddItem(ISplitItem item, DockPosition dockPosition, ISplitItem relativeTo)

Parameters

item

ISplitItem

The item to be added.

dockPosition

DockPosition

The relative position at which the item will be added.

relativeTo

ISplitItem

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

ChangeVisualState(bool)

Updates the visual states of the control.

Declaration

cs-api-definition
protected virtual void ChangeVisualState(bool useTransitions)

Parameters

useTransitions

bool

Identifies whether the transitions should be used.

ClearContainerForItemOverride(DependencyObject, object)

Clears the container for item override.

Declaration

cs-api-definition
protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters

element

DependencyObject

The element.

item

object

The item.

EnumeratePanes()

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

Declaration

cs-api-definition
public IEnumerable<RadPane> EnumeratePanes()

Returns

IEnumerable<RadPane>

Implements ISplitItem.EnumeratePanes()

GetContainerForItemOverride()

Gets the container for item override.

Declaration

cs-api-definition
protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject

Ready for use container.

GoToState(bool, params string[])

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

Declaration

cs-api-definition
protected void GoToState(bool useTransitions, params string[] stateNames)

Parameters

useTransitions

bool

Indicates whether transitions should be used.

stateNames

string[]

The names of the states that should be reached.

IsItemItsOwnContainerOverride(object)

Determines whether is the specified item its own container.

Declaration

cs-api-definition
protected override bool IsItemItsOwnContainerOverride(object item)

Parameters

item

object

The item.

Returns

bool

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

OnApplyTemplate()

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

Declaration

cs-api-definition
public override void OnApplyTemplate()

OnCreateAutomationPeer()

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

OnInitialized(EventArgs)

Raises the event and sets from the active theme.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

OnIsInDocumentHostChanged(bool, bool)

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

Declaration

cs-api-definition
protected virtual void OnIsInDocumentHostChanged(bool oldValue, bool newValue)

Parameters

oldValue

bool

The old value of the property.

newValue

bool

The new value of the property.

OnIsInToolWindowChanged(bool, bool)

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

Declaration

cs-api-definition
protected virtual void OnIsInToolWindowChanged(bool oldValue, bool newValue)

Parameters

oldValue

bool

The old value of the property.

newValue

bool

The new value of the property.

OnItemsChanged(NotifyCollectionChangedEventArgs)

Raises the event.

Declaration

cs-api-definition
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

e

NotifyCollectionChangedEventArgs

The NotifyCollectionChangedEventArgs instance containing the event data.

OnLoaded(object, RoutedEventArgs)

Called when the event is fired.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Security", "CA2109:ReviewVisibleEventHandlers")]
protected virtual void OnLoaded(object sender, RoutedEventArgs e)

Parameters

sender

object

The sender.

e

RoutedEventArgs

The RoutedEventArgs instance containing the event data.

PrepareContainerForItemOverride(DependencyObject, object)

Prepares the container for item override.

Declaration

cs-api-definition
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

element

DependencyObject

The element.

item

object

The item.

ResetTheme()

Resets the theme.

Declaration

cs-api-definition
public void ResetTheme()