Class RadPane

A content holder class for the Docking.

Inheritance
System.Object
RadTabItem
RadPane
RadDocumentPane
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Docking.dll

Syntax

[TelerikToolboxCategory("Containers")]
public class RadPane : RadTabItem, IRadTabItem, IPane, IDocumentHostAware, IToolWindowAware, IActiveAwareExtended, IActiveAware

Constructors

RadPane()

Initializes a new instance of the RadPane class.

Declaration
public RadPane()

Fields

AutoHideHeightProperty

Identifies the AutoHideHeight dependency property.

Declaration
public static readonly DependencyProperty AutoHideHeightProperty
Field Value
System.Windows.DependencyProperty

AutoHideWidthProperty

Identifies the AutoHideWidth dependency property.

Declaration
public static readonly DependencyProperty AutoHideWidthProperty
Field Value
System.Windows.DependencyProperty

CanDockInDocumentHostProperty

Identifies the CanDockInDocumentHost dependency property.

Declaration
public static readonly DependencyProperty CanDockInDocumentHostProperty
Field Value
System.Windows.DependencyProperty

CanFloatProperty

Identifies the CanFloat dependency property.

Declaration
public static readonly DependencyProperty CanFloatProperty
Field Value
System.Windows.DependencyProperty

CanUserCloseProperty

Identifies the CanUserClose dependency property.

Declaration
public static readonly DependencyProperty CanUserCloseProperty
Field Value
System.Windows.DependencyProperty

CanUserPinProperty

Identifies the CanUserPin dependency property.

Declaration
public static readonly DependencyProperty CanUserPinProperty
Field Value
System.Windows.DependencyProperty

ContextMenuTemplateProperty

Identifies the ContextMenuTemplate dependency property.

Declaration
public static readonly DependencyProperty ContextMenuTemplateProperty
Field Value
System.Windows.DependencyProperty

DocumentHostTemplateProperty

Identifies the DocumentHostTemplate dependency property.

Declaration
public static readonly DependencyProperty DocumentHostTemplateProperty
Field Value
System.Windows.DependencyProperty

IsActiveProperty

Identifies the IsActive dependency property.

Declaration
public static readonly DependencyProperty IsActiveProperty
Field Value
System.Windows.DependencyProperty

IsDockableOptionCheckedProperty

Identifies the IsDockableOptionChecked property.

Declaration
public static readonly DependencyProperty IsDockableOptionCheckedProperty
Field Value
System.Windows.DependencyProperty

IsDockableProperty

Identifies the IsDockable dependency property.

Declaration
public static readonly DependencyProperty IsDockableProperty
Field Value
System.Windows.DependencyProperty

IsDraggingProperty

Identifies the IsDragging dependency property.

Declaration
public static readonly DependencyProperty IsDraggingProperty
Field Value
System.Windows.DependencyProperty

IsFloatingOnlyProperty

Identifies the IsFloatingOnly property.

Declaration
public static readonly DependencyProperty IsFloatingOnlyProperty
Field Value
System.Windows.DependencyProperty

IsFloatingProperty

Identifies the IsFloating property.

Declaration
public static readonly DependencyProperty IsFloatingProperty
Field Value
System.Windows.DependencyProperty

IsHiddenProperty

Identifies the IsHidden dependency property.

Declaration
public static readonly DependencyProperty IsHiddenProperty
Field Value
System.Windows.DependencyProperty

IsInDocumentHostProperty

Identifies the IsInDocumentHost property.

Declaration
public static readonly DependencyProperty IsInDocumentHostProperty
Field Value
System.Windows.DependencyProperty

IsLastInGroupProperty

Identifies the IsLastInGroup dependency property.

Declaration
public static readonly DependencyProperty IsLastInGroupProperty
Field Value
System.Windows.DependencyProperty

IsPinnedProperty

Identifies the IsPinned dependency property.

Declaration
public static readonly DependencyProperty IsPinnedProperty
Field Value
System.Windows.DependencyProperty

IsReorderingProperty

Identifies the IsReordering dependency property.

Declaration
public static readonly DependencyProperty IsReorderingProperty
Field Value
System.Windows.DependencyProperty

MenuCommandsProperty

Identifies the MenuCommands dependency property.

Declaration
public static readonly DependencyProperty MenuCommandsProperty
Field Value
System.Windows.DependencyProperty

MenuItemTemplateProperty

Identifies the MenuItemTemplate dependency property.

Declaration
public static readonly DependencyProperty MenuItemTemplateProperty
Field Value
System.Windows.DependencyProperty

MenuItemTemplateSelectorProperty

Identifies the MenuItemTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty MenuItemTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

PaneHeaderVisibilityProperty

Identifies the PaneHeaderVisibility dependency property.

Declaration
public static readonly DependencyProperty PaneHeaderVisibilityProperty
Field Value
System.Windows.DependencyProperty

ParentDockingProperty

Identifies the CanUserPin ParentDocking property.

Declaration
public static readonly DependencyProperty ParentDockingProperty
Field Value
System.Windows.DependencyProperty

PinButtonVisibilityProperty

Identifies the PinButtonVisibility dependency property.

Declaration
public static readonly DependencyProperty PinButtonVisibilityProperty
Field Value
System.Windows.DependencyProperty

TitleProperty

Identifies the Title dependency property.

Declaration
public static readonly DependencyProperty TitleProperty
Field Value
System.Windows.DependencyProperty

TitleTemplateProperty

Identifies the TitleTemplate dependency property.

Declaration
public static readonly DependencyProperty TitleTemplateProperty
Field Value
System.Windows.DependencyProperty

Properties

AutoHideHeight

Gets or sets the height of the auto hide.

Declaration
public double AutoHideHeight { get; set; }
Property Value
System.Double

The height of the auto hide.

AutoHideWidth

Gets or sets the width of the auto hide.

Declaration
public double AutoHideWidth { get; set; }
Property Value
System.Double

The width of the auto hide.

CanDockInDocumentHost

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

Declaration
public bool CanDockInDocumentHost { get; set; }
Property Value
System.Boolean

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
public bool CanFloat { get; set; }
Property Value
System.Boolean

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
public bool CanUserClose { get; set; }
Property Value
System.Boolean

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
public bool CanUserPin { get; set; }
Property Value
System.Boolean

True if this instance can pin; otherwise, False.

CloseButtonVisibility

This property does not apply to RadPane.

Declaration
public Visibility CloseButtonVisibility { get; set; }
Property Value
System.Windows.Visibility

ContextMenuTemplate

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

Declaration
public DataTemplate ContextMenuTemplate { get; set; }
Property Value
System.Windows.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
public ControlTemplate DocumentHostTemplate { get; set; }
Property Value
System.Windows.Controls.ControlTemplate

IsActive

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

Declaration
public bool IsActive { get; set; }
Property Value
System.Boolean

True if this pane is active; otherwise, false.
Implements

IsDockable

Gets a value indicating whether this pane is dockable.

Declaration
public bool IsDockable { get; set; }
Property Value
System.Boolean

True if this pane is dockable; otherwise, false.

IsDockableOptionChecked

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

Declaration
public bool IsDockableOptionChecked { get; }
Property Value
System.Boolean

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
public bool IsDragging { get; }
Property Value
System.Boolean

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
public bool IsFloating { get; }
Property Value
System.Boolean

True if this pane is floating; otherwise, false.

IsFloatingOnly

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

Declaration
public bool IsFloatingOnly { get; }
Property Value
System.Boolean

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

IsHidden

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

Declaration
public bool IsHidden { get; set; }
Property Value
System.Boolean

True if this instance is hidden; otherwise, False.

IsInDocumentHost

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

Declaration
public bool IsInDocumentHost { get; }
Property Value
System.Boolean

IsLastInGroup

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

Declaration
public bool IsLastInGroup { get; }
Property Value
System.Boolean

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

IsPinned

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

Declaration
public bool IsPinned { get; set; }
Property Value
System.Boolean

True if this instance is pinned; otherwise, False.

IsReordering

Gets whether the RadPane control is currently reordering.

Declaration
public bool IsReordering { get; }
Property Value
System.Boolean

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

PaneGroup

Gets the group that owns the pane.

Declaration
public RadPaneGroup PaneGroup { get; }
Property Value
RadPaneGroup

PaneHeaderVisibility

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

Declaration
public Visibility PaneHeaderVisibility { get; set; }
Property Value
System.Windows.Visibility

PinButtonVisibility

Gets the visibility of the PinButton of this instance.

Declaration
public Visibility PinButtonVisibility { get; }
Property Value
System.Windows.Visibility

Title

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

Declaration
public object Title { get; set; }
Property Value
System.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
public DataTemplate TitleTemplate { get; set; }
Property Value
System.Windows.DataTemplate

The title template.

Methods

ChangeVisualState(Boolean)

Updates the visual state of the control.

Declaration
protected override void ChangeVisualState(bool useTransitions)
Parameters
System.Boolean useTransitions

Indicates whether transitions should be used.
Overrides

FindTemplateFromPosition(Dock)

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

Declaration
protected override ControlTemplate FindTemplateFromPosition(Dock position)
Parameters
System.Windows.Controls.Dock position

The position for which to return a template.
Returns
System.Windows.Controls.ControlTemplate

A control template to use.
Overrides

MakeDockable()

Makes the pane dockable.

Declaration
public void MakeDockable()

MakeFloatingDockable()

Makes the pane floating dockable.

Declaration
public void MakeFloatingDockable()

MakeFloatingOnly()

Makes the pane floating and not dockable.

Declaration
public void MakeFloatingOnly()

MoveToDocumentHost()

Moves the pane to the document host.

Declaration
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
public override void OnApplyTemplate()
Overrides

OnContextMenuTemplateChanged()

Update the RadPanes' context menu.

Declaration
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
protected virtual void OnDragDropCompleted(object sender, DragDropCompletedEventArgs e)
Parameters
System.Object sender

DragDropCompletedEventArgs e

OnDraggingChanged(DependencyPropertyChangedEventArgs)

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

Declaration
protected virtual void OnDraggingChanged(DependencyPropertyChangedEventArgs eventArgs)
Parameters
System.Windows.DependencyPropertyChangedEventArgs eventArgs

The event data.

OnDragInitialize(Object, DragInitializeEventArgs)

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

Declaration
protected virtual void OnDragInitialize(object sender, DragInitializeEventArgs e)
Parameters
System.Object sender

DragInitializeEventArgs e

OnHeaderMouseLeftButtonDown(Object, MouseButtonEventArgs)

Raises the MouseLeftButtonDown event.

Declaration
protected override void OnHeaderMouseLeftButtonDown(object sender, MouseButtonEventArgs e)
Parameters
System.Object sender

The sender.
System.Windows.Input.MouseButtonEventArgs e

The System.Windows.Input.MouseButtonEventArgs instance containing the event data.
Overrides

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event and sets System.Windows.FrameworkElement.DefaultStyleKey from the active theme.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.
Overrides

OnIsActiveChanged()

Occurs when IsActive property is changed.

Declaration
protected virtual void OnIsActiveChanged()

OnMouseEnter(MouseEventArgs)

Raises the MouseEnter event.

Declaration
protected override void OnMouseEnter(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

The System.Windows.Input.MouseEventArgs instance containing the event data.
Overrides

OnMouseLeave(MouseEventArgs)

Raises the MouseLeave event.

Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

The System.Windows.Input.MouseEventArgs instance containing the event data.
Overrides

OnStateChange(RadRoutedEventArgs)

Raises the StateChange event.

Declaration
protected virtual void OnStateChange(RadRoutedEventArgs routedEventArgs)
Parameters
RadRoutedEventArgs routedEventArgs

The RadRoutedEventArgs instance containing the event data.

RemoveFromParent()

Removes from parent.

Declaration
public void RemoveFromParent()

Events

Activated

Occurs when the RadPane is activated.

Declaration
public event EventHandler<EventArgs> Activated
Event Type
System.EventHandler<System.EventArgs>

Implements

Deactivated

Occurs when the RadPane is deactivated.

Declaration
public event EventHandler<EventArgs> Deactivated
Event Type
System.EventHandler<System.EventArgs>

Implements

Extension Methods