New to Telerik UI for WPFStart a free 30-day trial

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:

C#
[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.DropDownButtonStylePropertyRadTabControl.DropDownDisplayMemberPathPropertyRadTabControl.DropDownStylePropertyRadTabControl.IsDropDownOpenPropertyRadTabControl.DropDownDisplayModePropertyRadTabControl.ItemDropDownContentTemplatePropertyRadTabControl.ItemDropDownContentTemplateSelectorPropertyRadTabControl.PreviewTabClosedEventRadTabControl.TabClosedEventRadTabControl.PreviewTabPinnedEventRadTabControl.TabPinnedEventRadTabControl.PreviewTabUnpinnedEventRadTabControl.TabUnpinnedEventRadTabControl.ItemReorderedEventRadTabControl.AdditionalContentPropertyRadTabControl.AllowDragReorderPropertyRadTabControl.AllowDragOverTabPropertyRadTabControl.CloseTabsOnMouseMiddleButtonDownPropertyRadTabControl.ScrollModePropertyRadTabControl.InvertMouseWheelScrollDirectionPropertyRadTabControl.TabStripPlacementPropertyRadTabControl.LeftTemplatePropertyRadTabControl.RightTemplatePropertyRadTabControl.TopTemplatePropertyRadTabControl.BottomTemplatePropertyRadTabControl.OverflowModePropertyRadTabControl.AllTabsEqualHeightPropertyRadTabControl.AlignPropertyRadTabControl.TabOrientationPropertyRadTabControl.UpdateSelectedContentProperties()RadTabControl.GetContainer()RadTabControl.OnScrollButtonsVisibilityChanged()RadTabControl.OnDropDownMenuItemClick(object, RoutedEventArgs)RadTabControl.OnIsDropDownOpenChanged(bool, bool)RadTabControl.OnPreviewTabClosed(PreviewTabChangedEventArgs)RadTabControl.OnTabClosed(TabChangedEventArgs)RadTabControl.OnPreviewTabPinned(PreviewTabChangedEventArgs)RadTabControl.OnTabPinned(TabChangedEventArgs)RadTabControl.OnPreviewTabUnpinned(PreviewTabChangedEventArgs)RadTabControl.OnTabUnpinned(TabChangedEventArgs)RadTabControl.ScrollIntoView(object)RadTabControl.OnLeftScrollButtonClick(object, RoutedEventArgs)RadTabControl.OnRightScrollButtonClick(object, RoutedEventArgs)RadTabControl.OnItemsPanelChanged(ItemsPanelTemplate, ItemsPanelTemplate)RadTabControl.UpdateTabStrip()RadTabControl.DropDownButtonStyleRadTabControl.DropDownDisplayMemberPathRadTabControl.DropDownStyleRadTabControl.IsDropDownOpenRadTabControl.DropDownDisplayModeRadTabControl.ItemDropDownContentTemplateRadTabControl.ItemDropDownContentTemplateSelectorRadTabControl.PinnedItemsRadTabControl.AdditionalContentRadTabControl.AllowDragReorderRadTabControl.AllowDragOverTabRadTabControl.CloseTabsOnMouseMiddleButtonDownRadTabControl.ScrollModeRadTabControl.InvertMouseWheelScrollDirectionRadTabControl.TabStripPlacementRadTabControl.LeftTemplateRadTabControl.RightTemplateRadTabControl.TopTemplateRadTabControl.BottomTemplateRadTabControl.OverflowModeRadTabControl.AllTabsEqualHeightRadTabControl.AlignRadTabControl.TabOrientationRadTabControl.PreviewTabClosedRadTabControl.TabClosedRadTabControl.PreviewTabPinnedRadTabControl.TabPinnedRadTabControl.PreviewTabUnpinnedRadTabControl.TabUnpinnedRadTabControl.ItemReorderedRadTabControlBase.PreviewSelectionChangedEventRadTabControlBase.SelectionChangedEventRadTabControlBase.DropDownOpenedEventRadTabControlBase.DropDownClosedEventRadTabControlBase.HeaderBackgroundPropertyRadTabControlBase.ReorderTabRowsPropertyRadTabControlBase.SelectedContentPropertyRadTabControlBase.SelectedContentTemplatePropertyRadTabControlBase.SelectedContentTemplateSelectorPropertyRadTabControlBase.ContentTemplatePropertyRadTabControlBase.ContentTemplateSelectorPropertyRadTabControlBase.IsContentPreservedPropertyRadTabControlBase.PropagateItemDataContextToContentPropertyRadTabControlBase.SelectedItemRemoveBehaviourPropertyRadTabControlBase.BackgroundVisibilityPropertyRadTabControlBase.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.UpdateFocusOnSelectionChange()RadTabControlBase.HeaderBackgroundRadTabControlBase.ReorderTabRowsRadTabControlBase.SelectedContentRadTabControlBase.SelectedContentTemplateRadTabControlBase.SelectedContentTemplateSelectorRadTabControlBase.ContentTemplateRadTabControlBase.ContentTemplateSelectorRadTabControlBase.IsContentPreservedRadTabControlBase.PropagateItemDataContextToContentRadTabControlBase.SelectedItemRemoveBehaviourRadTabControlBase.SupressSelectedContentTemplateReapplyingRadTabControlBase.IsDefaultItemSelectedRadTabControlBase.TabStripRadTabControlBase.ContentElementRadTabControlBase.ContentElementsPanelRadTabControlBase.TabFlagsRadTabControlBase.this[int]RadTabControlBase.BackgroundVisibilityRadTabControlBase.PreviewSelectionChangedRadTabControlBase.SelectionChangedRadTabControlBase.DropDownOpenedRadTabControlBase.DropDownClosed...

Constructors

Initializes a new instance of the RadPaneGroup class.

C#
public RadPaneGroup()

Fields

Identifies the DocumentHostTemplate property.

C#
public static readonly DependencyProperty DocumentHostTemplateProperty

IsInDocumentHostProperty

DependencyProperty

Identifies the IsInDocumentHost property.

C#
public static readonly DependencyProperty IsInDocumentHostProperty

IsPaneHeaderVisibleProperty

DependencyProperty

Identifies the IsPaneHeaderVisible dependency property.

C#
public static readonly DependencyProperty IsPaneHeaderVisibleProperty

IsSingleItemProperty

DependencyProperty

Identifies the IsSingleItem dependency property.

C#
public static readonly DependencyProperty IsSingleItemProperty

SplitterPositionProperty

DependencyProperty

Identifies the ResizerPosition dependency property.

C#
public static readonly DependencyProperty SplitterPositionProperty

Properties

Control

Control

Gets the actual control that will be a visual child of the SplitContainer.

C#
public Control Control { get; }

Implements: ISplitItem.Control

DocumentHostTemplate

ControlTemplate

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

C#
public ControlTemplate DocumentHostTemplate { get; set; }

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

C#
public bool IsInDocumentHost { get; }

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

C#
public bool IsInToolWindow { get; }

Gets a value indicating whether the PaneHeader control is visible.

C#
public bool IsPaneHeaderVisible { get; }

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

C#
public bool IsSingleItem { get; }

Gets or sets the SplitContainer that holds the item.

C#
public RadSplitContainer ParentContainer { get; }
Property Value:

The RadSplitContainer that contains the pane group.

Implements: ISplitItem.ParentContainer

Gets the position of the Resizer in the RadPaneGroup template.

C#
public Dock? SplitterPosition { get; }

Gets all the unpinned panes owned by the PaneGroup.

C#
public IEnumerable<RadPane> UnpinnedPanes { get; }

Methods

Adds the group to the specified position.

C#
public void AddItem(ISplitItem item, DockPosition dockPosition)
Parameters:itemISplitItem

The split item to be added.

dockPositionDockPosition

The position at which the group will be added.

Adds the pane to the specified position.

C#
public void AddItem(RadPane pane, DockPosition dockPosition)
Parameters:paneRadPane

The pane to be added.

dockPositionDockPosition

The position at which the pane will be added.

Updates the visual states of the control.

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

Identifies whether the transitions should be used.

Overrides: RadTabControl.ChangeVisualState(bool)

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

C#
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters:elementDependencyObject

The container element.

itemobject

The Item.

Overrides: RadTabControl.ClearContainerForItemOverride(DependencyObject, object)

Enumerates the panes contained by the split item and its children.

C#
public IEnumerable<RadPane> EnumeratePanes()
Returns:

IEnumerable<RadPane>

Implements: ISplitItem.EnumeratePanes()

Finds the template from position.

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

The position.

Returns:

ControlTemplate

Overrides: RadTabControl.FindTemplateFromPosition(Dock)

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

C#
protected override DependencyObject GetContainerForItemOverride()
Returns:

DependencyObject

Overrides: RadTabControlBase.GetContainerForItemOverride()

Hides all panes.

C#
public void HideAllPanes()

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

C#
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters:itemobject

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)

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

C#
public override void OnApplyTemplate()

Overrides: PaneGroupBase.OnApplyTemplate()

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

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

The type-specific AutomationPeer implementation.

Overrides: PaneGroupBase.OnCreateAutomationPeer()

Called when a dock item is dragged.

C#
protected virtual void OnDockingElementReordered(Point globalPosition, object reorderedElement)
Parameters:globalPositionPoint

The global position of the mouse.

reorderedElementobject

The element that was reordered.

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

Called when the IToolWindowAware property changes. Allows the control to change its appearance and behavior when placed in a ToolWindow.

C#
protected virtual void OnIsInToolWindowChanged(bool oldValue, bool newValue)
Parameters:oldValuebool

The old value of the property.

newValuebool

The new value of the property.

Invoked when the property changes.

C#
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters:eNotifyCollectionChangedEventArgs

Information about the change.

Overrides: RadTabControl.OnItemsChanged(NotifyCollectionChangedEventArgs)

Pins all panes.

C#
public void PinAllPanes()

Prepares the specified element to display the specified item.

C#
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters:elementDependencyObject

Element used to display the specified item.

itemobject

Specified item.

Overrides: PaneGroupBase.PrepareContainerForItemOverride(DependencyObject, object)

Removes from parent.

C#
public void RemoveFromParent()

Removes the pane from the group.

C#
public void RemovePane(RadPane pane)
Parameters:paneRadPane

The pane to be removed.

Shows all panes.

C#
public void ShowAllPanes()

Unpins all panes.

C#
public void UnpinAllPanes()