Class
RadPaneGroup

Represents a group of panes within a docking layout, providing functionality for managing and organizing panes.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Docking.dll

Syntax:

cs-api-definition
[SuppressMessage("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling")]
[TelerikToolboxCategory("Containers")]
public class RadPaneGroup : PaneGroupBase, ISplitItem

Inheritance: objectRadTabControlBaseRadTabControlPaneGroupBaseRadPaneGroup

Implements: ISplitItem

Inherited Members PaneGroupBase.SelectedPanePropertyPaneGroupBase.ResetTheme()PaneGroupBase.OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)PaneGroupBase.OnGotFocus(RoutedEventArgs)PaneGroupBase.UpdateCheckedState(bool)PaneGroupBase.OnSelectionChanged(RadSelectionChangedEventArgs)PaneGroupBase.SelectedPanePaneGroupBase.PaneHeaderRadTabControl.PreviewTabClosedEventRadTabControl.TabClosedEventRadTabControl.PreviewTabPinnedEventRadTabControl.TabPinnedEventRadTabControl.PreviewTabUnpinnedEventRadTabControl.TabUnpinnedEventRadTabControl.DropDownButtonStylePropertyRadTabControl.DropDownDisplayMemberPathPropertyRadTabControl.DropDownStylePropertyRadTabControl.IsDropDownOpenPropertyRadTabControl.DropDownDisplayModePropertyRadTabControl.ItemDropDownContentTemplatePropertyRadTabControl.ItemDropDownContentTemplateSelectorPropertyRadTabControl.TabStripPlacementPropertyRadTabControl.LeftTemplatePropertyRadTabControl.RightTemplatePropertyRadTabControl.TopTemplatePropertyRadTabControl.BottomTemplatePropertyRadTabControl.OverflowModePropertyRadTabControl.AllTabsEqualHeightPropertyRadTabControl.AlignPropertyRadTabControl.TabOrientationPropertyRadTabControl.ItemReorderedEventRadTabControl.AdditionalContentPropertyRadTabControl.AllowDragReorderPropertyRadTabControl.AllowDragOverTabPropertyRadTabControl.CloseTabsOnMouseMiddleButtonDownPropertyRadTabControl.ScrollModePropertyRadTabControl.InvertMouseWheelScrollDirectionPropertyRadTabControl.OnPreviewTabClosed(PreviewTabChangedEventArgs)RadTabControl.OnTabClosed(TabChangedEventArgs)RadTabControl.OnPreviewTabPinned(PreviewTabChangedEventArgs)RadTabControl.OnTabPinned(TabChangedEventArgs)RadTabControl.OnPreviewTabUnpinned(PreviewTabChangedEventArgs)RadTabControl.OnTabUnpinned(TabChangedEventArgs)RadTabControl.OnDropDownMenuItemClick(object, RoutedEventArgs)RadTabControl.OnIsDropDownOpenChanged(bool, bool)RadTabControl.OnItemsPanelChanged(ItemsPanelTemplate, ItemsPanelTemplate)RadTabControl.UpdateTabStrip()RadTabControl.UpdateSelectedContentProperties()RadTabControl.GetContainer()RadTabControl.OnScrollButtonsVisibilityChanged()RadTabControl.ScrollIntoView(object)RadTabControl.OnLeftScrollButtonClick(object, RoutedEventArgs)RadTabControl.OnRightScrollButtonClick(object, RoutedEventArgs)RadTabControl.PinnedItemsRadTabControl.DropDownButtonStyleRadTabControl.DropDownDisplayMemberPathRadTabControl.DropDownStyleRadTabControl.IsDropDownOpenRadTabControl.DropDownDisplayModeRadTabControl.ItemDropDownContentTemplateRadTabControl.ItemDropDownContentTemplateSelectorRadTabControl.TabStripPlacementRadTabControl.LeftTemplateRadTabControl.RightTemplateRadTabControl.TopTemplateRadTabControl.BottomTemplateRadTabControl.OverflowModeRadTabControl.AllTabsEqualHeightRadTabControl.AlignRadTabControl.TabOrientationRadTabControl.AdditionalContentRadTabControl.AllowDragReorderRadTabControl.AllowDragOverTabRadTabControl.CloseTabsOnMouseMiddleButtonDownRadTabControl.ScrollModeRadTabControl.InvertMouseWheelScrollDirectionRadTabControl.PreviewTabClosedRadTabControl.TabClosedRadTabControl.PreviewTabPinnedRadTabControl.TabPinnedRadTabControl.PreviewTabUnpinnedRadTabControl.TabUnpinnedRadTabControl.ItemReorderedRadTabControlBase.BackgroundVisibilityPropertyRadTabControlBase.PreviewSelectionChangedEventRadTabControlBase.SelectionChangedEventRadTabControlBase.DropDownOpenedEventRadTabControlBase.DropDownClosedEventRadTabControlBase.HeaderBackgroundPropertyRadTabControlBase.ReorderTabRowsPropertyRadTabControlBase.SelectedContentPropertyRadTabControlBase.SelectedContentTemplatePropertyRadTabControlBase.SelectedContentTemplateSelectorPropertyRadTabControlBase.ContentTemplatePropertyRadTabControlBase.ContentTemplateSelectorPropertyRadTabControlBase.IsContentPreservedPropertyRadTabControlBase.PropagateItemDataContextToContentPropertyRadTabControlBase.SelectedItemRemoveBehaviourPropertyRadTabControlBase.UpdateFocusOnSelectionChange()RadTabControlBase.Selector_SelectionChanged(object, SelectionChangedEventArgs)RadTabControlBase.UpdateTabRows()RadTabControlBase.GoToState(bool, params string[])RadTabControlBase.OnPreviewSelectionChanged(SelectionChangedEventArgs)RadTabControlBase.IsSelectionNonBoundAtClientSide()RadTabControlBase.ClearContentSafely()RadTabControlBase.AddDropDownOpenedHandler(UIElement, DropDownEventHandler)RadTabControlBase.RemoveDropDownOpenedHandler(UIElement, DropDownEventHandler)RadTabControlBase.AddDropDownClosedHandler(UIElement, DropDownEventHandler)RadTabControlBase.RemoveDropDownClosedHandler(UIElement, DropDownEventHandler)RadTabControlBase.BackgroundVisibilityRadTabControlBase.HeaderBackgroundRadTabControlBase.ReorderTabRowsRadTabControlBase.SelectedContentRadTabControlBase.SelectedContentTemplateRadTabControlBase.SelectedContentTemplateSelectorRadTabControlBase.ContentTemplateRadTabControlBase.ContentTemplateSelectorRadTabControlBase.IsContentPreservedRadTabControlBase.PropagateItemDataContextToContentRadTabControlBase.SelectedItemRemoveBehaviourRadTabControlBase.SupressSelectedContentTemplateReapplyingRadTabControlBase.IsDefaultItemSelectedRadTabControlBase.TabStripRadTabControlBase.ContentElementRadTabControlBase.ContentElementsPanelRadTabControlBase.TabFlagsRadTabControlBase.this[int]RadTabControlBase.PreviewSelectionChangedRadTabControlBase.SelectionChangedRadTabControlBase.DropDownOpenedRadTabControlBase.DropDownClosed

Constructors

RadPaneGroup()

Initializes a new instance of the RadPaneGroup class.

Declaration

cs-api-definition
public RadPaneGroup()

Fields

DocumentHostTemplateProperty

Identifies the DocumentHostTemplate property.

Declaration

cs-api-definition
public static readonly DependencyProperty DocumentHostTemplateProperty

Field Value

DependencyProperty

IsInDocumentHostProperty

Identifies the IsInDocumentHost property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsInDocumentHostProperty

Field Value

DependencyProperty

IsPaneHeaderVisibleProperty

Identifies the IsPaneHeaderVisible dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsPaneHeaderVisibleProperty

Field Value

DependencyProperty

IsSingleItemProperty

Identifies the IsSingleItem dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsSingleItemProperty

Field Value

DependencyProperty

SplitterPositionProperty

Identifies the ResizerPosition dependency 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

DocumentHostTemplate

Gets or sets the template that will be applied to the TabGroup when it is in a DocumentHost. This is a dependency property.

Declaration

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

Property Value

ControlTemplate

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

IsPaneHeaderVisible

Gets a value indicating whether the PaneHeader control is visible.

Declaration

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

Property Value

bool

IsSingleItem

Gets a value indicating whether the instance has a single item.

Declaration

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

Property Value

bool

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 pane group.

Implements ISplitItem.ParentContainer

SplitterPosition

Gets the position of the Resizer in the RadPaneGroup template.

Declaration

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

Property Value

Dock?

UnpinnedPanes

Gets all the unpinned panes owned by the PaneGroup.

Declaration

cs-api-definition
public IEnumerable<RadPane> UnpinnedPanes { get; }

Property Value

IEnumerable<RadPane>

Methods

AddItem(ISplitItem, DockPosition)

Adds the group to the specified position.

Declaration

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

Parameters

item

ISplitItem

The split item to be added.

dockPosition

DockPosition

The position at which the group will be added.

AddItem(RadPane, DockPosition)

Adds the pane to the specified position.

Declaration

cs-api-definition
public void AddItem(RadPane pane, DockPosition dockPosition)

Parameters

pane

RadPane

The pane to be added.

dockPosition

DockPosition

The position at which the pane will be added.

ChangeVisualState(bool)

Updates the visual states of the control.

Declaration

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

Parameters

useTransitions

bool

Identifies whether the transitions should be used.

Overrides RadTabControl.ChangeVisualState(bool)

ClearContainerForItemOverride(DependencyObject, object)

When overridden in a derived class, undoes the effects of the method.

Declaration

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

Parameters

element

DependencyObject

The container element.

item

object

The Item.

Overrides RadTabControl.ClearContainerForItemOverride(DependencyObject, object)

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()

FindTemplateFromPosition(Dock)

Finds the template from position.

Declaration

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

Parameters

position

Dock

The position.

Returns

ControlTemplate

Overrides RadTabControl.FindTemplateFromPosition(Dock)

GetContainerForItemOverride()

Creates or identifies the element that is used to display the given item.

Declaration

cs-api-definition
protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject

Overrides RadTabControlBase.GetContainerForItemOverride()

HideAllPanes()

Hides all panes.

Declaration

cs-api-definition
public void HideAllPanes()

IsItemItsOwnContainerOverride(object)

Determines if the specified item is (or is eligible to be) its own container.

Declaration

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

Parameters

item

object

The item to check.

Returns

bool

True if the item is (or is eligible to be) its own container; otherwise, false.

Overrides RadTabControlBase.IsItemItsOwnContainerOverride(object)

OnApplyTemplate()

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

Declaration

cs-api-definition
public override void OnApplyTemplate()

Overrides PaneGroupBase.OnApplyTemplate()

OnCreateAutomationPeer()

Provides an appropriate RadPaneGroupAutomationPeer implementation for this control, as part of the automation infrastructure.

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

The type-specific AutomationPeer implementation.

Overrides PaneGroupBase.OnCreateAutomationPeer()

OnDockingElementReordered(Point, object)

Called when a dock item is dragged.

Declaration

cs-api-definition
protected virtual void OnDockingElementReordered(Point globalPosition, object reorderedElement)

Parameters

globalPosition

Point

The global position of the mouse.

reorderedElement

object

The element that was reordered.

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 RadTabControl.OnInitialized(EventArgs)

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)

Invoked when the property changes.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")]
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

e

NotifyCollectionChangedEventArgs

Information about the change.

Overrides RadTabControl.OnItemsChanged(NotifyCollectionChangedEventArgs)

PinAllPanes()

Pins all panes.

Declaration

cs-api-definition
public void PinAllPanes()

PrepareContainerForItemOverride(DependencyObject, object)

Prepares the specified element to display the specified item.

Declaration

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

Parameters

element

DependencyObject

Element used to display the specified item.

item

object

Specified item.

Overrides PaneGroupBase.PrepareContainerForItemOverride(DependencyObject, object)

RemoveFromParent()

Removes from parent.

Declaration

cs-api-definition
public void RemoveFromParent()

RemovePane(RadPane)

Removes the pane from the group.

Declaration

cs-api-definition
public void RemovePane(RadPane pane)

Parameters

pane

RadPane

The pane to be removed.

ShowAllPanes()

Shows all panes.

Declaration

cs-api-definition
public void ShowAllPanes()

UnpinAllPanes()

Unpins all panes.

Declaration

cs-api-definition
public void UnpinAllPanes()