Class DockingPanesFactory

This factory helps PanesSource property usage in MVVM scenarios. It creates new RadPane instances, check whether an item is its own container or not and adds the new generated RadPane to the RadDocking control.

Inheritance
System.Object
DockingPanesFactory
Namespace: Telerik.Windows.Controls.Docking
Assembly: Telerik.Windows.Controls.Docking.dll

Syntax

public class DockingPanesFactory : Object

Constructors

DockingPanesFactory()

Declaration
public DockingPanesFactory()

Methods

AddPane(RadDocking, RadPane)

Adds the pane to the radDocking layout. If there is no available containers to generate the new content please use the radDocking's GeneratedItemsFactory to create additional RadSplitContainers and RadPaneGroups.

Declaration
protected virtual void AddPane(RadDocking radDocking, RadPane pane)
Parameters
RadDocking radDocking

The RadDocking a RadPane instance is being added to.
RadPane pane

The RadPane to add.

CreatePaneForItem(Object)

Creates a new RadPane instance for item from the PanesSource collection. Make sure to apply set any properties, styles and templates so that the generated RadPane may look properly in the RadDocking. For example set any of the DataContext, Header, Title or Content based on the item as well as Style with bindings in the style setters to bind properties of the item to properties of the RadPane.

Declaration
protected virtual RadPane CreatePaneForItem(object item)
Parameters
System.Object item

The item a RadPane is generated for.
Returns
RadPane

A new instance of the RadPane class.

CreatePaneForItem(RadDocking, Object)

Creates a new RadPane instance for item from the PanesSource collection. Make sure to apply set any properties, styles and templates so that the generated RadPane may look properly in the RadDocking. For example set any of the DataContext, Header, Title or Content based on the item as well as Style with bindings in the style setters to bind properties of the item to properties of the RadPane.

Declaration
protected virtual RadPane CreatePaneForItem(RadDocking radDocking, object item)
Parameters
RadDocking radDocking

The RadDocking a RadPane instance is being added to.
System.Object item

The item a RadPane is generated for.
Returns
RadPane

A new instance of the RadPane class.

GetPaneFromItem(RadDocking, Object)

Gets the RadPane from the item parameter.

Declaration
protected virtual RadPane GetPaneFromItem(RadDocking docking, object item)
Parameters
RadDocking docking

The RadDocking a RadPane instance is being get to.
System.Object item

The item which is used to get the pane.
Returns
RadPane

The RadPane instance.

IsItemItsOwnPaneContainer(Object)

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

Declaration
protected virtual bool IsItemItsOwnPaneContainer(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 RadPane container; otherwise, false.

RemovePane(RadPane)

Removes the pane from the RadDocking layout. By default clears the Header, Content, DataContext and call RemoveFromParent method.

Declaration
protected virtual void RemovePane(RadPane pane)
Parameters
RadPane pane

The RadPane to remove.

Extension Methods