ClassRadPaneGroup
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:
[SuppressMessage("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling")]
[TelerikToolboxCategory("Containers")]
public class RadPaneGroup : PaneGroupBase, ISplitItem
Inheritance: objectRadTabControlBaseRadTabControlPaneGroupBaseRadPaneGroup
Implements:
Inherited Members
Constructors
RadPaneGroup()
Initializes a new instance of the RadPaneGroup class.
Declaration
public RadPaneGroup()
Fields
DocumentHostTemplateProperty
Identifies the DocumentHostTemplate property.
Declaration
public static readonly DependencyProperty DocumentHostTemplateProperty
Field Value
DependencyProperty
IsInDocumentHostProperty
Identifies the IsInDocumentHost property.
Declaration
public static readonly DependencyProperty IsInDocumentHostProperty
Field Value
DependencyProperty
IsPaneHeaderVisibleProperty
Identifies the IsPaneHeaderVisible dependency property.
Declaration
public static readonly DependencyProperty IsPaneHeaderVisibleProperty
Field Value
DependencyProperty
IsSingleItemProperty
Identifies the IsSingleItem dependency property.
Declaration
public static readonly DependencyProperty IsSingleItemProperty
Field Value
DependencyProperty
SplitterPositionProperty
Identifies the ResizerPosition dependency property.
Declaration
[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
public Control Control { get; }
Property Value
Control
Implements
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
public ControlTemplate DocumentHostTemplate { get; set; }
Property Value
ControlTemplate
IsInDocumentHost
Gets a value indicating whether the object is contained within a DocumentHost.
IsInToolWindow
Gets a value indicating whether the object is contained within a ToolWindow.
IsPaneHeaderVisible
Gets a value indicating whether the PaneHeader control is visible.
IsSingleItem
Gets a value indicating whether the instance has a single item.
ParentContainer
Gets or sets the SplitContainer that holds the item.
Declaration
public RadSplitContainer ParentContainer { get; }
Property Value
The RadSplitContainer that contains the pane group.
Implements
SplitterPosition
Gets the position of the Resizer in the RadPaneGroup template.
Declaration
[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
public IEnumerable<RadPane> UnpinnedPanes { get; }
Property Value
Methods
AddItem(ISplitItem, DockPosition)
Adds the group to the specified position.
Declaration
public void AddItem(ISplitItem item, DockPosition dockPosition)
Parameters
item
The split item to be added.
dockPosition
The position at which the group will be added.
AddItem(RadPane, DockPosition)
Adds the pane to the specified position.
Declaration
public void AddItem(RadPane pane, DockPosition dockPosition)
Parameters
pane
The pane to be added.
dockPosition
The position at which the pane will be added.
ChangeVisualState(bool)
Updates the visual states of the control.
Declaration
protected override void ChangeVisualState(bool useTransitions)
Parameters
useTransitions
Identifies whether the transitions should be used.
Overrides
ClearContainerForItemOverride(DependencyObject, object)
When overridden in a derived class, undoes the effects of the method.
Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
element
DependencyObject
The container element.
item
The Item.
Overrides
EnumeratePanes()
Enumerates the panes contained by the split item and its children.
Declaration
public IEnumerable<RadPane> EnumeratePanes()
Returns
Implements
FindTemplateFromPosition(Dock)
Finds the template from position.
Declaration
protected override ControlTemplate FindTemplateFromPosition(Dock position)
Parameters
position
Dock
The position.
Returns
ControlTemplate
Overrides
GetContainerForItemOverride()
Creates or identifies the element that is used to display the given item.
Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
DependencyObject
Overrides
IsItemItsOwnContainerOverride(object)
Determines if the specified item is (or is eligible to be) its own container.
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call .
Declaration
public override void OnApplyTemplate()
Overrides
OnCreateAutomationPeer()
Provides an appropriate RadPaneGroupAutomationPeer implementation for this control, as part of the automation infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
AutomationPeer
The type-specific AutomationPeer implementation.
Overrides
OnDockingElementReordered(Point, object)
Called when a dock item is dragged.
Declaration
protected virtual void OnDockingElementReordered(Point globalPosition, object reorderedElement)
Parameters
globalPosition
Point
The global position of the mouse.
reorderedElement
The element that was reordered.
OnInitialized(EventArgs)
Raises the event and sets from the active theme.
Declaration
protected override void OnInitialized(EventArgs e)
Parameters
e
The RoutedEventArgs that contains the event data.
Overrides
OnIsInToolWindowChanged(bool, bool)
Called when the IToolWindowAware property changes. Allows the control to change its appearance and behavior when placed in a ToolWindow.
OnItemsChanged(NotifyCollectionChangedEventArgs)
Invoked when the property changes.
Declaration
[SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")]
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
e
NotifyCollectionChangedEventArgs
Information about the change.
Overrides
PrepareContainerForItemOverride(DependencyObject, object)
Prepares the specified element to display the specified item.
Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
element
DependencyObject
Element used to display the specified item.
item
Specified item.
Overrides
RemovePane(RadPane)
Removes the pane from the group.
Declaration
public void RemovePane(RadPane pane)
Parameters
pane
The pane to be removed.