Class RadPaneGroup
Navigation control which presents the RadPanes as TabItems.
Inheritance
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Docking.dll
Syntax
[TelerikToolboxCategory("Containers")]
public class RadPaneGroup : PaneGroupBase, IThemable, ISplitItem, IDocumentHostAware, IToolWindowAware, ISupportsResize
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
System.Windows.DependencyProperty
|
IsInDocumentHostProperty
Identifies the IsInDocumentHost property.
Declaration
public static readonly DependencyProperty IsInDocumentHostProperty
Field Value
System.Windows.DependencyProperty
|
IsPaneHeaderVisibleProperty
Identifies the IsPaneHeaderVisible dependency property.
Declaration
public static readonly DependencyProperty IsPaneHeaderVisibleProperty
Field Value
System.Windows.DependencyProperty
|
IsSingleItemProperty
Identifies the IsSingleItem dependency property.
Declaration
public static readonly DependencyProperty IsSingleItemProperty
Field Value
System.Windows.DependencyProperty
|
SplitterPositionProperty
Identifies the ResizerPosition dependency property.
Declaration
public static readonly DependencyProperty SplitterPositionProperty
Field Value
System.Windows.DependencyProperty
|
Properties
Control
Gets the actual control that will be a visual child of the SplitContainer.
Declaration
public Control Control { get; }
Property Value
System.Windows.Controls.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
System.Windows.Controls.ControlTemplate
|
IsInDocumentHost
Gets a value indicating whether the object is contained within a DocumentHost.
Declaration
public bool IsInDocumentHost { get; }
Property Value
System.Boolean
|
IsInToolWindow
Gets a value indicating whether the object is contained within a ToolWindow.
Declaration
public bool IsInToolWindow { get; }
Property Value
System.Boolean
|
IsPaneHeaderVisible
Gets a value indicating whether the PaneHeader control is visible.
Declaration
public bool IsPaneHeaderVisible { get; }
Property Value
System.Boolean
|
IsSingleItem
Gets a value indicating whether the instance has a single item.
Declaration
public bool IsSingleItem { get; }
Property Value
System.Boolean
|
ParentContainer
Gets or sets the SplitContainer that holds the item.
Declaration
public RadSplitContainer ParentContainer { get; }
Property Value
RadSplitContainer
The RadSplitContainer that contains the pane group. |
Implements
SplitterPosition
Gets the position of the Resizer in the RadPaneGroup template.
Declaration
public Nullable<Dock> SplitterPosition { get; }
Property Value
System.Nullable<Dock>
|
UnpinnedPanes
Gets all the unpinned panes owned by the PaneGroup.
Declaration
public IEnumerable<RadPane> UnpinnedPanes { get; }
Property Value
System.Collections.Generic.IEnumerable<RadPane>
|
Methods
AddItem(ISplitItem, DockPosition)
Adds the group to the specified position.
Declaration
public void AddItem(ISplitItem item, DockPosition dockPosition)
Parameters
ISplitItem
item
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
public void AddItem(RadPane pane, DockPosition dockPosition)
Parameters
RadPane
pane
The pane to be added. |
DockPosition
dockPosition
The position at which the pane will be added. |
ChangeVisualState(Boolean)
Updates the visual states of the control.
Declaration
protected override void ChangeVisualState(bool useTransitions)
Parameters
System.Boolean
useTransitions
Identifies whether the transitions should be used. |
Overrides
ClearContainerForItemOverride(DependencyObject, Object)
When overridden in a derived class, undoes the effects of the System.Windows.Controls.ItemsControl.PrepareContainerForItemOverride(System.Windows.DependencyObject,System.Object) method.
Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject
element
The container element. |
System.Object
item
The Item. |
Overrides
EnumeratePanes()
Enumerates the panes contained by the split item and its children.
Declaration
public IEnumerable<RadPane> EnumeratePanes()
Returns
System.Collections.Generic.IEnumerable<RadPane>
|
Implements
FindTemplateFromPosition(Dock)
Finds the template from position.
Declaration
protected override ControlTemplate FindTemplateFromPosition(Dock position)
Parameters
Dock
position
The position. |
Returns
System.Windows.Controls.ControlTemplate
|
Overrides
GetContainerForItemOverride()
Creates or identifies the element that is used to display the given item.
Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
System.Windows.DependencyObject
|
Overrides
HideAllPanes()
Hides all panes.
Declaration
public void HideAllPanes()
IsItemItsOwnContainerOverride(Object)
Determines if the specified item is (or is eligible to be) its own container.
Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
System.Object
item
The item to check. |
Returns
System.Boolean
True if the item is (or is eligible to be) its own container; otherwise, false. |
Overrides
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
OnCreateAutomationPeer()
Provides an appropriate RadPaneGroupAutomationPeer implementation for this control, as part of the automation infrastructure.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer
The type-specific System.Windows.Automation.Peers.AutomationPeer implementation. |
Overrides
OnDockingElementReordered(Point, Object)
Called when a dock item is dragged.
Declaration
protected virtual void OnDockingElementReordered(Point globalPosition, object reorderedElement)
Parameters
System.Windows.Point
globalPosition
The global position of the mouse. |
System.Object
reorderedElement
The element that was reordered. |
OnIsInToolWindowChanged(Boolean, Boolean)
Called when the IToolWindowAware property changes. Allows the control to change its appearance and behavior when placed in a ToolWindow.
Declaration
protected virtual void OnIsInToolWindowChanged(bool oldValue, bool newValue)
Parameters
System.Boolean
oldValue
The old value of the property. |
System.Boolean
newValue
The new value of the property. |
OnItemsChanged(NotifyCollectionChangedEventArgs)
Invoked when the System.Windows.Controls.ItemsControl.Items property changes.
Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
System.Collections.Specialized.NotifyCollectionChangedEventArgs
e
Information about the change. |
Overrides
PinAllPanes()
Pins all panes.
Declaration
public void PinAllPanes()
PrepareContainerForItemOverride(DependencyObject, Object)
Prepares the specified element to display the specified item.
Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject
element
Element used to display the specified item. |
System.Object
item
Specified item. |
Overrides
RemoveFromParent()
Removes from parent.
Declaration
public void RemoveFromParent()
RemovePane(RadPane)
Removes the pane from the group.
Declaration
public void RemovePane(RadPane pane)
Parameters
RadPane
pane
The pane to be removed. |
ShowAllPanes()
Shows all panes.
Declaration
public void ShowAllPanes()
UnpinAllPanes()
Unpins all panes.
Declaration
public void UnpinAllPanes()