Back to all docs
API Reference / Telerik.Blazor.Components / TelerikDockManager
New to Telerik UI for Blazor? Start a free 30-day trial

TelerikDockManager

Class

The DockManager component enables you to create complex layouts with dockable, resizable, floatable and pinnable panes. Children: DockManagerPanes, DockManagerFloatingPanes.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:
C#
public class TelerikDockManager : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikDockManager

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.Dispose()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeVoidAsyncWithoutAwait(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnParametersSet()ComponentBase.OnParametersSetAsync()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)ComponentBase.SetParametersAsync(ParameterView)...

Constructors

TelerikDockManager()

C#
public TelerikDockManager()

Properties

DockManagerFloatingPanes

The floating panes of the DockManager. Children: DockManagerSplitPane.

C#
[Parameter]
public RenderFragment DockManagerFloatingPanes { get; set; }

DockManagerPanes

The root panes of the DockManager. Children: DockManagerContentPane, DockManagerTabGroupPane, DockManagerSplitPane.

C#
[Parameter]
public RenderFragment DockManagerPanes { get; set; }

Height

Defines the height of the DockManager as a CSS value. Supports units like px, %, em, or rem (e.g., "600px", "100vh"). If not specified, the component uses auto-sizing based on its content.

C#
[Parameter]
public string Height { get; set; }

OnDock

Fires when a pane is docked to a new position within the DockManager layout. This event is cancelable - set IsCancelled to true to prevent the dock operation.

C#
[Parameter]
public EventCallback<DockManagerDockEventArgs> OnDock { get; set; }

OnPaneResize

Fires when a splitter pane is resized by the user dragging the splitter bar. Use this event to respond to size changes and update related UI elements or data.

C#
[Parameter]
public EventCallback<DockManagerPaneResizeEventArgs> OnPaneResize { get; set; }

OnPin

Fires when a previously unpinned pane is pinned back to its docked position. This event is cancelable - set IsCancelled to true to prevent the pin operation.

C#
[Parameter]
public EventCallback<DockManagerPinEventArgs> OnPin { get; set; }

OnStateChanged

Fires whenever the DockManager layout state changes due to user interactions like docking, undocking, or resizing. Use this event to save the current state or synchronize the layout with external data.

C#
[Parameter]
public EventCallback<DockManagerStateEventArgs> OnStateChanged { get; set; }

OnStateInit

Fires once when the DockManager is initialized, allowing you to access and modify the initial layout state. Use the event arguments to retrieve or set the DockManagerState for programmatic layout control.

C#
[Parameter]
public EventCallback<DockManagerStateEventArgs> OnStateInit { get; set; }

OnUndock

Fires when a pane is undocked and converted to a floating window. This event is cancelable - set IsCancelled to true to prevent the undock operation.

C#
[Parameter]
public EventCallback<DockManagerUndockEventArgs> OnUndock { get; set; }

OnUnpin

Fires when a pane is unpinned and collapsed to show only its header tab. This event is cancelable - set IsCancelled to true to prevent the unpin operation.

C#
[Parameter]
public EventCallback<DockManagerUnpinEventArgs> OnUnpin { get; set; }

Orientation

Defines the root splitter orientation that controls how panes are arranged within the DockManager. Horizontal arranges panes side by side, while Vertical stacks them vertically. The default value is Horizontal.

C#
[Parameter]
public DockManagerPaneOrientation Orientation { get; set; }

Width

Defines the width of the DockManager as a CSS value. Supports units like px, %, em, or rem (e.g., "800px", "100%"). If not specified, the component uses auto-sizing based on its content.

C#
[Parameter]
public string Width { get; set; }

Methods

BuildRenderTree(RenderTreeBuilder)

C#
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

GetState()

Gets the current state of the DockManager.

C#
public DockManagerState GetState()
Returns:

DockManagerState

DockManagerState.

OnAfterRenderAsync(bool)

C#
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters:firstRenderboolReturns:

Task

Overrides: BaseComponent.OnAfterRenderAsync(bool)

OnInitialized()

C#
protected override void OnInitialized()

Overrides: ComponentBase.OnInitialized()

Refresh()

Refreshes the DockManager.

C#
public void Refresh()

SetState(DockManagerState)

Sets the state of the DockManager.

C#
public void SetState(DockManagerState state)
Parameters:stateDockManagerState

DockManagerState.

In this article
DefinitionConstructorsTelerikDockManager()PropertiesDockManagerFloatingPanesDockManagerPanesHeightOnDockOnPaneResizeOnPinOnStateChangedOnStateInitOnUndockOnUnpinOrientationWidthMethodsBuildRenderTree(RenderTreeBuilder)GetState()OnAfterRenderAsync(bool)OnInitialized()Refresh()SetState(DockManagerState)
Not finding the help you need?
Contact Support