ClassRadSplitContainer
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:
[TelerikToolboxCategory("Containers")]
public class RadSplitContainer : ItemsControl, ISplitItem
Inheritance: objectRadSplitContainer
Implements:
Constructors
RadSplitContainer()
Initializes a new instance of the RadSplitContainer class.
Declaration
public RadSplitContainer()
Fields
InitialPositionProperty
Identifies the InitialPosition dependency property.
Declaration
public static readonly DependencyProperty InitialPositionProperty
Field Value
DependencyProperty
OrientationProperty
Identifies the OrientationProperty dependency property.
Declaration
public static readonly DependencyProperty OrientationProperty
Field Value
DependencyProperty
SplitterPositionProperty
Identifies the ResizerPosition property.
Declaration
[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
public Control Control { get; }
Property Value
Control
Implements
InitialPosition
Gets or sets the initial position.
Declaration
public DockState InitialPosition { get; set; }
Property Value
The initial position.
IsInDocumentHost
Gets a value indicating whether the object is contained within a DocumentHost.
IsInToolWindow
Gets a value indicating whether the object is contained within a ToolWindow.
Orientation
Gets or sets the orientation.
Declaration
public Orientation Orientation { get; set; }
Property Value
Orientation
The orientation.
ParentContainer
Gets or sets the SplitContainer that holds the item.
Declaration
public RadSplitContainer ParentContainer { get; }
Property Value
The RadSplitContainer that contains the split container.
Implements
SplitterPosition
Gets the position of the Resizer in the RadSplitContainer template.
Declaration
[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
public void AddItem(ISplitItem item, DockPosition dockPosition, ISplitItem relativeTo)
Parameters
item
The item to be added.
dockPosition
The relative position at which the item will be added.
relativeTo
The item, relative to which the new one will be added.
ChangeVisualState(bool)
Updates the visual states of the control.
Declaration
protected virtual void ChangeVisualState(bool useTransitions)
Parameters
useTransitions
Identifies whether the transitions should be used.
ClearContainerForItemOverride(DependencyObject, object)
Clears the container for item override.
Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
element
DependencyObject
The element.
item
The item.
EnumeratePanes()
Enumerates the panes contained by the split item and its children.
Declaration
public IEnumerable<RadPane> EnumeratePanes()
Returns
Implements
GetContainerForItemOverride()
Gets the container for item override.
Declaration
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.
IsItemItsOwnContainerOverride(object)
Determines whether is the specified item its own container.
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate().
Declaration
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
AutomationPeer
OnInitialized(EventArgs)
Raises the event and sets from the active theme.
Declaration
protected override void OnInitialized(EventArgs e)
Parameters
e
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.
OnIsInToolWindowChanged(bool, bool)
Called when the IToolWindowAware property changes. Allows the control to change its appearance and behavior when placed in a ToolWindow.
OnItemsChanged(NotifyCollectionChangedEventArgs)
Raises the event.
Declaration
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
[SuppressMessage("Microsoft.Security", "CA2109:ReviewVisibleEventHandlers")]
protected virtual void OnLoaded(object sender, RoutedEventArgs e)
Parameters
sender
The sender.
e
RoutedEventArgs
The RoutedEventArgs instance containing the event data.
PrepareContainerForItemOverride(DependencyObject, object)
Prepares the container for item override.
Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
element
DependencyObject
The element.
item
The item.