Back to all docs
API Reference / Telerik.Windows.Controls / RadPane
New to Telerik UI for WPF? Start a free 30-day trial

RadPane

Class

Represents a pane control that can be pinned, docked, or floated within a RadDocking layout. The RadPane class inherits from RadTabItem and implements multiple interfaces such as IPane, IDocumentHostAware, IToolWindowAware, IActiveAware, and IActiveAwareExtended. It provides support for visual states, including Normal, Selected, MouseOver, Disabled, Focused, and others, allowing for extensive customization of its behavior and appearance.

The RadPane includes properties for managing its active state, hidden state and pinned state. It also supports context menus and provides events to handle activation and deactivation, making it ideal for complex UI scenarios such as tabbed interfaces, tool windows, and document hosts.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Docking.dll

Syntax:
C#
[TelerikToolboxCategory("Containers")]
public class RadPane : RadTabItem, IRadTabItem, IActiveAware

Inheritance: objectRadTabItemRadPane

Derived Classes: RadDocumentPane

Implements: IActiveAwareIRadTabItem

Inherited Members RadTabItem.TabStripPlacementPropertyRadTabItem.TabOrientationPropertyRadTabItem.IsSelectedPropertyRadTabItem.IsBreakPropertyRadTabItem.CloseButtonVisibilityPropertyRadTabItem.LeftTemplatePropertyRadTabItem.RightTemplatePropertyRadTabItem.TopTemplatePropertyRadTabItem.BottomTemplatePropertyRadTabItem.DropDownContentPropertyRadTabItem.DropDownContentTemplatePropertyRadTabItem.DropDownContentTemplateSelectorPropertyRadTabItem.HeaderForegroundPropertyRadTabItem.IsDragDisabledPropertyRadTabItem.OnSelected(RadRoutedEventArgs)RadTabItem.OnUnselected(RadRoutedEventArgs)RadTabItem.UpdateTemplate()RadTabItem.OnCreateAutomationPeer()RadTabItem.OnHeaderChanged(object, object)RadTabItem.OnLoaded(object, RoutedEventArgs)RadTabItem.OnKeyDown(KeyEventArgs)RadTabItem.OnContentChanged(object, object)RadTabItem.MeasureOverride(Size)RadTabItem.OnHeaderMouseLeftButtonUp(object, MouseButtonEventArgs)RadTabItem.OnHeaderMouseEnter(object, MouseEventArgs)RadTabItem.OnHeaderMouseLeave(object, MouseEventArgs)RadTabItem.OnIsSelectedChanged(bool, bool)RadTabItem.OnGotFocus(RoutedEventArgs)RadTabItem.OnLostFocus(RoutedEventArgs)RadTabItem.SetNavigationMode(KeyboardNavigationMode)RadTabItem.TabStripPlacementRadTabItem.TabOrientationRadTabItem.IsSelectedRadTabItem.IsDragDisabledRadTabItem.IsBreakRadTabItem.CloseButtonVisibilityRadTabItem.LeftTemplateRadTabItem.RightTemplateRadTabItem.TopTemplateRadTabItem.BottomTemplateRadTabItem.DropDownContentRadTabItem.DropDownContentTemplateRadTabItem.DropDownContentTemplateSelectorRadTabItem.HeaderForeground...

Constructors

RadPane()

Initializes a new instance of the RadPane class.

C#
public RadPane()

Fields

AutoHideHeightProperty

DependencyProperty

Identifies the AutoHideHeight dependency property.

C#
public static readonly DependencyProperty AutoHideHeightProperty

AutoHideWidthProperty

DependencyProperty

Identifies the AutoHideWidth dependency property.

C#
public static readonly DependencyProperty AutoHideWidthProperty

CanDockInDocumentHostProperty

DependencyProperty

Identifies the CanDockInDocumentHost dependency property.

C#
public static readonly DependencyProperty CanDockInDocumentHostProperty

CanFloatProperty

DependencyProperty

Identifies the CanFloat dependency property.

C#
public static readonly DependencyProperty CanFloatProperty

CanUserCloseProperty

DependencyProperty

Identifies the CanUserClose dependency property.

C#
public static readonly DependencyProperty CanUserCloseProperty

CanUserPinProperty

DependencyProperty

Identifies the CanUserPin dependency property.

C#
public static readonly DependencyProperty CanUserPinProperty

ContextMenuTemplateProperty

DependencyProperty

Identifies the ContextMenuTemplate dependency property.

C#
public static readonly DependencyProperty ContextMenuTemplateProperty

DocumentHostTemplateProperty

DependencyProperty

Identifies the DocumentHostTemplate dependency property.

C#
public static readonly DependencyProperty DocumentHostTemplateProperty

IsActiveProperty

DependencyProperty

Identifies the IsActive dependency property.

C#
public static readonly DependencyProperty IsActiveProperty

IsDockableOptionCheckedProperty

DependencyProperty

Identifies the IsDockableOptionChecked property.

C#
public static readonly DependencyProperty IsDockableOptionCheckedProperty

IsDockableProperty

DependencyProperty

Identifies the IsDockable dependency property.

C#
public static readonly DependencyProperty IsDockableProperty

IsDraggingProperty

DependencyProperty

Identifies the IsDragging dependency property.

C#
public static readonly DependencyProperty IsDraggingProperty

IsFloatingOnlyProperty

DependencyProperty

Identifies the IsFloatingOnly property.

C#
public static readonly DependencyProperty IsFloatingOnlyProperty

IsFloatingProperty

DependencyProperty

Identifies the IsFloating property.

C#
public static readonly DependencyProperty IsFloatingProperty

IsHiddenProperty

DependencyProperty

Identifies the IsHidden dependency property.

C#
public static readonly DependencyProperty IsHiddenProperty

IsInDocumentHostProperty

DependencyProperty

Identifies the IsInDocumentHost property.

C#
public static readonly DependencyProperty IsInDocumentHostProperty

IsLastInGroupProperty

DependencyProperty

Identifies the IsLastInGroup dependency property.

C#
public static readonly DependencyProperty IsLastInGroupProperty

IsPinnedProperty

DependencyProperty

Identifies the IsPinned dependency property.

C#
public static readonly DependencyProperty IsPinnedProperty

IsReorderingProperty

DependencyProperty

Identifies the IsReordering dependency property.

C#
public static readonly DependencyProperty IsReorderingProperty

MenuCommandsProperty

DependencyProperty

Identifies the MenuCommands dependency property.

C#
public static readonly DependencyProperty MenuCommandsProperty

MenuItemTemplateProperty

DependencyProperty

Identifies the MenuItemTemplate dependency property.

C#
public static readonly DependencyProperty MenuItemTemplateProperty

MenuItemTemplateSelectorProperty

DependencyProperty

Identifies the MenuItemTemplateSelector dependency property.

C#
public static readonly DependencyProperty MenuItemTemplateSelectorProperty

PaneHeaderVisibilityProperty

DependencyProperty

Identifies the PaneHeaderVisibility dependency property.

C#
public static readonly DependencyProperty PaneHeaderVisibilityProperty

ParentDockingProperty

DependencyProperty

Identifies the CanUserPin ParentDocking property.

C#
public static readonly DependencyProperty ParentDockingProperty

PinButtonVisibilityProperty

DependencyProperty

Identifies the PinButtonVisibility dependency property.

C#
public static readonly DependencyProperty PinButtonVisibilityProperty

TitleProperty

DependencyProperty

Identifies the Title dependency property.

C#
public static readonly DependencyProperty TitleProperty

TitleTemplateProperty

DependencyProperty

Identifies the TitleTemplate dependency property.

C#
public static readonly DependencyProperty TitleTemplateProperty

Properties

AutoHideHeight

Gets or sets the height of the auto hide.

C#
public double AutoHideHeight { get; set; }
Property Value:

The height of the auto hide.

AutoHideWidth

Gets or sets the width of the auto hide.

C#
public double AutoHideWidth { get; set; }
Property Value:

The width of the auto hide.

CanDockInDocumentHost

Gets or sets a value indicating whether this instance can dock in the document host.

C#
public bool CanDockInDocumentHost { get; set; }
Property Value:

True if this instance can dock in the document host; otherwise, false.

CanFloat

Gets or sets a value indicating whether this pane can float.

C#
public bool CanFloat { get; set; }
Property Value:

True if this pane can float; otherwise, false.

CanUserClose

Gets or sets a value indicating whether this instance can be closed by the user.

C#
public bool CanUserClose { get; set; }
Property Value:

True if this instance can close; otherwise, False.

CanUserPin

Gets or sets a value indicating whether this instance can be pinned by the user.

C#
public bool CanUserPin { get; set; }
Property Value:

True if this instance can pin; otherwise, False.

ContextMenuTemplate

DataTemplate

Gets or sets Header's context menu that is containing the commands.

C#
public DataTemplate ContextMenuTemplate { get; set; }

DocumentHostTemplate

ControlTemplate

Gets or sets the template that will be applied when the RadPane is placed in a DocumentHost. This is a dependency property.

C#
public ControlTemplate DocumentHostTemplate { get; set; }

IsActive

Gets or sets a value indicating whether this pane is active.

C#
public bool IsActive { get; set; }
Property Value:

True if this pane is active; otherwise, false.

Implements: IActiveAware.IsActive

IsDockable

Gets a value indicating whether this pane is dockable.

C#
public bool IsDockable { get; set; }
Property Value:

True if this pane is dockable; otherwise, false.

IsDockableOptionChecked

Gets a value indicating whether this pane is floating and not dockable.

C#
public bool IsDockableOptionChecked { get; }
Property Value:

True if this pane is floating and not dockable; otherwise, false.

IsDragging

Gets whether the RadPane control has logical focus and mouse capture and the left mouse button is pressed.

C#
[Browsable(false)]
public bool IsDragging { get; }
Property Value:

True if the RadPane control has focus and mouse capture; otherwise false. The default value is false.

IsFloating

Gets a value indicating whether this pane is floating.

C#
public bool IsFloating { get; }
Property Value:

True if this pane is floating; otherwise, false.

IsFloatingOnly

Gets a value indicating whether this pane is floating and not dockable.

C#
public bool IsFloatingOnly { get; }
Property Value:

True if this pane is floating and not dockable; otherwise, false.

IsHidden

Gets or sets a value indicating whether this instance is hidden.

C#
public bool IsHidden { get; set; }
Property Value:

True if this instance is hidden; otherwise, False.

IsInDocumentHost

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

C#
public bool IsInDocumentHost { get; }

IsLastInGroup

Gets a value indicating whether this instance is first in group.

C#
public bool IsLastInGroup { get; }
Property Value:

True if this instance is first in group; otherwise, False.

IsPinned

Gets or sets a value indicating whether this instance is pinned.

C#
public bool IsPinned { get; set; }
Property Value:

True if this instance is pinned; otherwise, False.

IsReordering

Gets whether the RadPane control is currently reordering.

C#
[Browsable(false)]
public bool IsReordering { get; }
Property Value:

True if the RadPane control is reordering otherwise false. The default value is false.

PaneGroup

Gets the group that owns the pane.

C#
public RadPaneGroup PaneGroup { get; }

PaneHeaderVisibility

Visibility

Gets or sets a value describing the visibility of the header of the pane.

C#
public Visibility PaneHeaderVisibility { get; set; }

PinButtonVisibility

Visibility

Gets the visibility of the PinButton of this instance.

C#
public Visibility PinButtonVisibility { get; }

Title

Gets or sets the title of the RadPane. This is a dependency property.

C#
public object Title { get; set; }
Remarks:

The title of the RadPane appears in the top header part of the pane, while its header is the content of its tab button.

TitleTemplate

DataTemplate

Gets or sets the title template.

C#
public DataTemplate TitleTemplate { get; set; }
Property Value:

The title template.

Methods

ChangeVisualState(bool)

Updates the visual state of the control.

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

Indicates whether transitions should be used.

Overrides: RadTabItem.ChangeVisualState(bool)

FindTemplateFromPosition(Dock)

ControlTemplate

Returns the template that will be used, based on the position of the TabStrip.

C#
protected override ControlTemplate FindTemplateFromPosition(Dock position)
Parameters:positionDock

The position for which to return a template.

Returns:

ControlTemplate

A control template to use.

Overrides: RadTabItem.FindTemplateFromPosition(Dock)

MakeDockable()

Makes the pane dockable.

C#
public void MakeDockable()

MakeFloatingDockable()

Makes the pane floating dockable.

C#
public void MakeFloatingDockable()

MakeFloatingOnly()

Makes the pane floating and not dockable.

C#
public void MakeFloatingOnly()

MoveToDocumentHost()

Moves the pane to the document host.

C#
public void MoveToDocumentHost()

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate().

C#
public override void OnApplyTemplate()

Overrides: RadTabItem.OnApplyTemplate()

OnContextMenuTemplateChanged()

Update the RadPanes' context menu.

C#
protected virtual void OnContextMenuTemplateChanged()

OnDragDropCompleted(object, DragDropCompletedEventArgs)

Occurs when the input system reports an underlying drop event with this element as the drag origin.

C#
protected virtual void OnDragDropCompleted(object sender, DragDropCompletedEventArgs e)
Parameters:senderobjecteDragDropCompletedEventArgs

OnDraggingChanged(DependencyPropertyChangedEventArgs)

Responds to a change in the value of the IsDragging property.

C#
protected virtual void OnDraggingChanged(DependencyPropertyChangedEventArgs eventArgs)
Parameters:eventArgsDependencyPropertyChangedEventArgs

The event data.

OnDragInitialize(object, DragInitializeEventArgs)

Occurs when the input system reports an underlying drag event with this element as the drag origin.

C#
protected virtual void OnDragInitialize(object sender, DragInitializeEventArgs e)
Parameters:senderobjecteDragInitializeEventArgs

OnHeaderMouseLeftButtonDown(object, MouseButtonEventArgs)

Raises the event.

C#
protected override void OnHeaderMouseLeftButtonDown(object sender, MouseButtonEventArgs e)
Parameters:senderobject

The sender.

eMouseButtonEventArgs

The MouseButtonEventArgs instance containing the event data.

Overrides: RadTabItem.OnHeaderMouseLeftButtonDown(object, MouseButtonEventArgs)

OnInitialized(EventArgs)

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.

Overrides: RadTabItem.OnInitialized(EventArgs)

OnIsActiveChanged()

Occurs when IsActive property is changed.

C#
protected virtual void OnIsActiveChanged()

OnMouseEnter(MouseEventArgs)

Raises the event.

C#
protected override void OnMouseEnter(MouseEventArgs e)
Parameters:eMouseEventArgs

The MouseEventArgs instance containing the event data.

Overrides: RadTabItem.OnMouseEnter(MouseEventArgs)

OnMouseLeave(MouseEventArgs)

Raises the event.

C#
protected override void OnMouseLeave(MouseEventArgs e)
Parameters:eMouseEventArgs

The MouseEventArgs instance containing the event data.

Overrides: RadTabItem.OnMouseLeave(MouseEventArgs)

OnStateChange(RadRoutedEventArgs)

Raises the event.

C#
protected virtual void OnStateChange(RadRoutedEventArgs routedEventArgs)
Parameters:routedEventArgsRadRoutedEventArgs

The RadRoutedEventArgs instance containing the event data.

RemoveFromParent()

Removes from parent.

C#
public void RemoveFromParent()

Events

Activated

Occurs when the RadPane is activated.

C#
public event EventHandler<EventArgs> Activated

Implements: IActiveAware.Activated

Deactivated

Occurs when the RadPane is deactivated.

C#
public event EventHandler<EventArgs> Deactivated

Implements: IActiveAware.Deactivated

Extension Methods

DockingLogicalTreeHelper.GetParentDocking(RadPane)
DockingLogicalTreeHelper.GetParentSplitContainer(RadPane)
DockingLogicalTreeHelper.GetParentToolWindow(RadPane)
DockingLogicalTreeHelper.GetRootLevelSplitContainer(RadPane)
In this article
DefinitionConstructorsRadPane()FieldsAutoHideHeightPropertyAutoHideWidthPropertyCanDockInDocumentHostPropertyCanFloatPropertyCanUserClosePropertyCanUserPinPropertyContextMenuTemplatePropertyDocumentHostTemplatePropertyIsActivePropertyIsDockableOptionCheckedPropertyIsDockablePropertyIsDraggingPropertyIsFloatingOnlyPropertyIsFloatingPropertyIsHiddenPropertyIsInDocumentHostPropertyIsLastInGroupPropertyIsPinnedPropertyIsReorderingPropertyMenuCommandsPropertyMenuItemTemplatePropertyMenuItemTemplateSelectorPropertyPaneHeaderVisibilityPropertyParentDockingPropertyPinButtonVisibilityPropertyTitlePropertyTitleTemplatePropertyPropertiesAutoHideHeightAutoHideWidthCanDockInDocumentHostCanFloatCanUserCloseCanUserPinContextMenuTemplateDocumentHostTemplateIsActiveIsDockableIsDockableOptionCheckedIsDraggingIsFloatingIsFloatingOnlyIsHiddenIsInDocumentHostIsLastInGroupIsPinnedIsReorderingPaneGroupPaneHeaderVisibilityPinButtonVisibilityTitleTitleTemplateMethodsChangeVisualState(bool)FindTemplateFromPosition(Dock)MakeDockable()MakeFloatingDockable()MakeFloatingOnly()MoveToDocumentHost()OnApplyTemplate()OnContextMenuTemplateChanged()OnDragDropCompleted(object, DragDropCompletedEventArgs)OnDraggingChanged(DependencyPropertyChangedEventArgs)OnDragInitialize(object, DragInitializeEventArgs)OnHeaderMouseLeftButtonDown(object, MouseButtonEventArgs)OnInitialized(EventArgs)OnIsActiveChanged()OnMouseEnter(MouseEventArgs)OnMouseLeave(MouseEventArgs)OnStateChange(RadRoutedEventArgs)RemoveFromParent()EventsActivatedDeactivatedExtension Methods
Not finding the help you need?
Contact Support