Back to all docs
API Reference / Telerik.Windows.Controls / RadPane

Class
RadPane

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:
cs-api-definition
[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.

Declaration

cs-api-definition
public RadPane()

Fields

AutoHideHeightProperty

Identifies the AutoHideHeight dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty AutoHideHeightProperty

Field Value

DependencyProperty

AutoHideWidthProperty

Identifies the AutoHideWidth dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty AutoHideWidthProperty

Field Value

DependencyProperty

CanDockInDocumentHostProperty

Identifies the CanDockInDocumentHost dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CanDockInDocumentHostProperty

Field Value

DependencyProperty

CanFloatProperty

Identifies the CanFloat dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CanFloatProperty

Field Value

DependencyProperty

CanUserCloseProperty

Identifies the CanUserClose dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CanUserCloseProperty

Field Value

DependencyProperty

CanUserPinProperty

Identifies the CanUserPin dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CanUserPinProperty

Field Value

DependencyProperty

ContextMenuTemplateProperty

Identifies the ContextMenuTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ContextMenuTemplateProperty

Field Value

DependencyProperty

DocumentHostTemplateProperty

Identifies the DocumentHostTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DocumentHostTemplateProperty

Field Value

DependencyProperty

IsActiveProperty

Identifies the IsActive dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsActiveProperty

Field Value

DependencyProperty

IsDockableOptionCheckedProperty

Identifies the IsDockableOptionChecked property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsDockableOptionCheckedProperty

Field Value

DependencyProperty

IsDockableProperty

Identifies the IsDockable dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsDockableProperty

Field Value

DependencyProperty

IsDraggingProperty

Identifies the IsDragging dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsDraggingProperty

Field Value

DependencyProperty

IsFloatingOnlyProperty

Identifies the IsFloatingOnly property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsFloatingOnlyProperty

Field Value

DependencyProperty

IsFloatingProperty

Identifies the IsFloating property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsFloatingProperty

Field Value

DependencyProperty

IsHiddenProperty

Identifies the IsHidden dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsHiddenProperty

Field Value

DependencyProperty

IsInDocumentHostProperty

Identifies the IsInDocumentHost property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsInDocumentHostProperty

Field Value

DependencyProperty

IsLastInGroupProperty

Identifies the IsLastInGroup dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsLastInGroupProperty

Field Value

DependencyProperty

IsPinnedProperty

Identifies the IsPinned dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsPinnedProperty

Field Value

DependencyProperty

IsReorderingProperty

Identifies the IsReordering dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsReorderingProperty

Field Value

DependencyProperty

MenuCommandsProperty

Identifies the MenuCommands dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty MenuCommandsProperty

Field Value

DependencyProperty

MenuItemTemplateProperty

Identifies the MenuItemTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty MenuItemTemplateProperty

Field Value

DependencyProperty

MenuItemTemplateSelectorProperty

Identifies the MenuItemTemplateSelector dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty MenuItemTemplateSelectorProperty

Field Value

DependencyProperty

PaneHeaderVisibilityProperty

Identifies the PaneHeaderVisibility dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty PaneHeaderVisibilityProperty

Field Value

DependencyProperty

ParentDockingProperty

Identifies the CanUserPin ParentDocking property.

Declaration

cs-api-definition
public static readonly DependencyProperty ParentDockingProperty

Field Value

DependencyProperty

PinButtonVisibilityProperty

Identifies the PinButtonVisibility dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty PinButtonVisibilityProperty

Field Value

DependencyProperty

TitleProperty

Identifies the Title dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TitleProperty

Field Value

DependencyProperty

TitleTemplateProperty

Identifies the TitleTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty TitleTemplateProperty

Field Value

DependencyProperty

Properties

AutoHideHeight

Gets or sets the height of the auto hide.

Declaration

cs-api-definition
public double AutoHideHeight { get; set; }

Property Value

double

The height of the auto hide.

AutoHideWidth

Gets or sets the width of the auto hide.

Declaration

cs-api-definition
public double AutoHideWidth { get; set; }

Property Value

double

The width of the auto hide.

CanDockInDocumentHost

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

Declaration

cs-api-definition
public bool CanDockInDocumentHost { get; set; }

Property Value

bool

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

CanFloat

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

Declaration

cs-api-definition
public bool CanFloat { get; set; }

Property Value

bool

True if this pane can float; otherwise, false.

CanUserClose

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

Declaration

cs-api-definition
public bool CanUserClose { get; set; }

Property Value

bool

True if this instance can close; otherwise, False.

CanUserPin

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

Declaration

cs-api-definition
public bool CanUserPin { get; set; }

Property Value

bool

True if this instance can pin; otherwise, False.

ContextMenuTemplate

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

Declaration

cs-api-definition
public DataTemplate ContextMenuTemplate { get; set; }

Property Value

DataTemplate

DocumentHostTemplate

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

Declaration

cs-api-definition
public ControlTemplate DocumentHostTemplate { get; set; }

Property Value

ControlTemplate

IsActive

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

Declaration

cs-api-definition
public bool IsActive { get; set; }

Property Value

bool

True if this pane is active; otherwise, false.

Implements IActiveAware.IsActive

IsDockable

Gets a value indicating whether this pane is dockable.

Declaration

cs-api-definition
public bool IsDockable { get; set; }

Property Value

bool

True if this pane is dockable; otherwise, false.

IsDockableOptionChecked

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

Declaration

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

Property Value

bool

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.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsDragging { get; }

Property Value

bool

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.

Declaration

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

Property Value

bool

True if this pane is floating; otherwise, false.

IsFloatingOnly

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

Declaration

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

Property Value

bool

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

IsHidden

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

Declaration

cs-api-definition
public bool IsHidden { get; set; }

Property Value

bool

True if this instance is hidden; otherwise, False.

IsInDocumentHost

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

Declaration

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

Property Value

bool

IsLastInGroup

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

Declaration

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

Property Value

bool

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

IsPinned

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

Declaration

cs-api-definition
public bool IsPinned { get; set; }

Property Value

bool

True if this instance is pinned; otherwise, False.

IsReordering

Gets whether the RadPane control is currently reordering.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsReordering { get; }

Property Value

bool

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

PaneGroup

Gets the group that owns the pane.

Declaration

cs-api-definition
public RadPaneGroup PaneGroup { get; }

Property Value

RadPaneGroup

PaneHeaderVisibility

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

Declaration

cs-api-definition
public Visibility PaneHeaderVisibility { get; set; }

Property Value

Visibility

PinButtonVisibility

Gets the visibility of the PinButton of this instance.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Usage", "CA2222:DoNotDecreaseInheritedMemberVisibility")]
public Visibility PinButtonVisibility { get; }

Property Value

Visibility

Title

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

Declaration

cs-api-definition
public object Title { get; set; }

Property Value

object

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

Gets or sets the title template.

Declaration

cs-api-definition
public DataTemplate TitleTemplate { get; set; }

Property Value

DataTemplate

The title template.

Methods

ChangeVisualState(bool)

Updates the visual state of the control.

Declaration

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

Parameters

useTransitions

bool

Indicates whether transitions should be used.

Overrides RadTabItem.ChangeVisualState(bool)

FindTemplateFromPosition(Dock)

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

Declaration

cs-api-definition
protected override ControlTemplate FindTemplateFromPosition(Dock position)

Parameters

position

Dock

The position for which to return a template.

Returns

ControlTemplate

A control template to use.

Overrides RadTabItem.FindTemplateFromPosition(Dock)

MakeDockable()

Makes the pane dockable.

Declaration

cs-api-definition
public void MakeDockable()

MakeFloatingDockable()

Makes the pane floating dockable.

Declaration

cs-api-definition
public void MakeFloatingDockable()

MakeFloatingOnly()

Makes the pane floating and not dockable.

Declaration

cs-api-definition
public void MakeFloatingOnly()

MoveToDocumentHost()

Moves the pane to the document host.

Declaration

cs-api-definition
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().

Declaration

cs-api-definition
public override void OnApplyTemplate()

Overrides RadTabItem.OnApplyTemplate()

OnContextMenuTemplateChanged()

Update the RadPanes' context menu.

Declaration

cs-api-definition
protected virtual void OnContextMenuTemplateChanged()

OnDragDropCompleted(object, DragDropCompletedEventArgs)

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

Declaration

cs-api-definition
protected virtual void OnDragDropCompleted(object sender, DragDropCompletedEventArgs e)

Parameters

sender

object

e

DragDropCompletedEventArgs

OnDragInitialize(object, DragInitializeEventArgs)

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

Declaration

cs-api-definition
protected virtual void OnDragInitialize(object sender, DragInitializeEventArgs e)

Parameters

sender

object

e

DragInitializeEventArgs

OnDraggingChanged(DependencyPropertyChangedEventArgs)

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

Declaration

cs-api-definition
protected virtual void OnDraggingChanged(DependencyPropertyChangedEventArgs eventArgs)

Parameters

eventArgs

DependencyPropertyChangedEventArgs

The event data.

OnHeaderMouseLeftButtonDown(object, MouseButtonEventArgs)

Raises the event.

Declaration

cs-api-definition
protected override void OnHeaderMouseLeftButtonDown(object sender, MouseButtonEventArgs e)

Parameters

sender

object

The sender.

e

MouseButtonEventArgs

The MouseButtonEventArgs instance containing the event data.

Overrides RadTabItem.OnHeaderMouseLeftButtonDown(object, MouseButtonEventArgs)

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.

Overrides RadTabItem.OnInitialized(EventArgs)

OnIsActiveChanged()

Occurs when IsActive property is changed.

Declaration

cs-api-definition
protected virtual void OnIsActiveChanged()

OnMouseEnter(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
protected override void OnMouseEnter(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

Overrides RadTabItem.OnMouseEnter(MouseEventArgs)

OnMouseLeave(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
protected override void OnMouseLeave(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

Overrides RadTabItem.OnMouseLeave(MouseEventArgs)

OnStateChange(RadRoutedEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnStateChange(RadRoutedEventArgs routedEventArgs)

Parameters

routedEventArgs

RadRoutedEventArgs

The RadRoutedEventArgs instance containing the event data.

RemoveFromParent()

Removes from parent.

Declaration

cs-api-definition
public void RemoveFromParent()

Events

Activated

Occurs when the RadPane is activated.

Declaration

cs-api-definition
public event EventHandler<EventArgs> Activated

Event Value

EventHandler<EventArgs>

Implements IActiveAware.Activated

Deactivated

Occurs when the RadPane is deactivated.

Declaration

cs-api-definition
public event EventHandler<EventArgs> Deactivated

Event Value

EventHandler<EventArgs>

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)OnDragInitialize(object, DragInitializeEventArgs)OnDraggingChanged(DependencyPropertyChangedEventArgs)OnHeaderMouseLeftButtonDown(object, MouseButtonEventArgs)OnInitialized(EventArgs)OnIsActiveChanged()OnMouseEnter(MouseEventArgs)OnMouseLeave(MouseEventArgs)OnStateChange(RadRoutedEventArgs)RemoveFromParent()EventsActivatedDeactivatedExtension Methods
Not finding the help you need?
Contact Support