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.

Definition

Namespace:Telerik.Windows.Controls.Docking

Assembly:Telerik.Windows.Controls.Docking.dll

Syntax:

cs-api-definition
public class DockingPanesFactory

Inheritance: objectDockingPanesFactory

Constructors

DockingPanesFactory()

Declaration

cs-api-definition
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

cs-api-definition
protected virtual void AddPane(RadDocking radDocking, RadPane pane)

Parameters

radDocking

RadDocking

The RadDocking a RadPane instance is being added to.

pane

RadPane

The RadPane to add.

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

cs-api-definition
protected virtual RadPane CreatePaneForItem(RadDocking radDocking, object item)

Parameters

radDocking

RadDocking

The RadDocking a RadPane instance is being added to.

item

object

The item a RadPane is generated for.

Returns

RadPane

A new instance of the RadPane class.

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

cs-api-definition
protected virtual RadPane CreatePaneForItem(object item)

Parameters

item

object

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

cs-api-definition
protected virtual RadPane GetPaneFromItem(RadDocking docking, object item)

Parameters

docking

RadDocking

The RadDocking a RadPane instance is being get to.

item

object

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

cs-api-definition
protected virtual bool IsItemItsOwnPaneContainer(object item)

Parameters

item

object

The item to check.

Returns

bool

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

cs-api-definition
protected virtual void RemovePane(RadPane pane)

Parameters

pane

RadPane

The RadPane to remove.