Class
DockingLogicalTreeHelper

This class helps traversing the logical tree of the Docking control.

Definition

Namespace:Telerik.Windows.Controls.Docking

Assembly:Telerik.Windows.Controls.Docking.dll

Syntax:

cs-api-definition
[SuppressMessage("Microsoft.Naming", "CA1708:IdentifiersShouldDifferByMoreThanCase")]
public static class DockingLogicalTreeHelper

Inheritance: objectDockingLogicalTreeHelper

Methods

GetParentDocking(ISplitItem)

Retrieves the parent docking element of a specified split item within the docking layout.

Declaration

cs-api-definition
public static RadDocking GetParentDocking(this ISplitItem splitContainer)

Parameters

splitContainer

ISplitItem

The split container whose parent docking element is to be retrieved.

Returns

RadDocking

The parent docking element of the provided split container, or null if no parent exists.

GetParentDocking(RadPane)

Retrieves the parent docking element of the specified RadPane.

Declaration

cs-api-definition
public static RadDocking GetParentDocking(this RadPane pane)

Parameters

pane

RadPane

The RadPane for which to get the parent docking element.

Returns

RadDocking

The parent docking element of the specified RadPane, or null if no parent exists.

GetParentDocking(ToolWindow)

Gets the parent Docking control of the ToolWindow.

Declaration

cs-api-definition
public static RadDocking GetParentDocking(this ToolWindow window)

Parameters

window

ToolWindow

Returns

RadDocking

GetParentPane(UIElement)

Retrieves the parent pane of the specified UI element in the logical tree of the docking layout.

Declaration

cs-api-definition
public static RadPane GetParentPane(this UIElement element)

Parameters

element

UIElement

The UIElement for which to find the parent pane.

Returns

RadPane

The parent pane of the specified UI element, or null if the element does not belong to a pane.

GetParentSplitContainer(ISplitItem)

Retrieves the parent split container of a specified split item in the docking layout.

Declaration

cs-api-definition
public static RadSplitContainer GetParentSplitContainer(this ISplitItem splitItem)

Parameters

splitItem

ISplitItem

The split item for which to find the parent split container.

Returns

RadSplitContainer

The parent split container of the specified split item, or null if none exists.

GetParentSplitContainer(RadPane)

Retrieves the parent split container of the specified RadPane from the logical tree.

Declaration

cs-api-definition
public static RadSplitContainer GetParentSplitContainer(this RadPane radPane)

Parameters

radPane

RadPane

The RadPane for which to find the parent split container.

Returns

RadSplitContainer

The parent SplitContainer of the specified RadPane, or null if not found.

GetParentToolWindow(ISplitItem)

Retrieves the parent tool window of the specified split item in the docking layout.

Declaration

cs-api-definition
public static ToolWindow GetParentToolWindow(this ISplitItem splitContainer)

Parameters

splitContainer

ISplitItem

The split container for which to find the parent tool window.

Returns

ToolWindow

The parent tool window associated with the specified split container, or null if none exists.

GetParentToolWindow(RadPane)

Retrieves the parent tool window for the specified RadPane.

Declaration

cs-api-definition
public static ToolWindow GetParentToolWindow(this RadPane pane)

Parameters

pane

RadPane

The RadPane for which to find the parent tool window.

Returns

ToolWindow

The parent ToolWindow of the specified RadPane, or null if no parent tool window exists.

GetRootLevelSplitContainer(ISplitItem)

Resolves the RadSplitContainer, which direct parent is not a SplitContainer, containing the target element. Commonly these are the split containers, hosted in ToolWindow or directly in the RadDocking control.

Declaration

cs-api-definition
[CLSCompliant(false)]
public static RadSplitContainer GetRootLevelSplitContainer(this ISplitItem splitItem)

Parameters

splitItem

ISplitItem

The RadPaneGroup or RadSplitContainer which root-level container to search for.

Returns

RadSplitContainer

A RadSplitContainer which direct parent is not of type RadSplitContainer.

GetRootLevelSplitContainer(RadPane)

Resolves the RadSplitContainer, which direct parent is not a SplitContainer, containing the target element. Commonly these are the split containers, hosted in ToolWindow or directly in the RadDocking control.

Declaration

cs-api-definition
[CLSCompliant(false)]
public static RadSplitContainer GetRootLevelSplitContainer(this RadPane pane)

Parameters

pane

RadPane

The RadPane which root-level container to search for.

Returns

RadSplitContainer

A RadSplitContainer which direct parent is not of type RadSplitContainer.