ClassTelerikDockManager
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:
public class TelerikDockManager : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Inheritance: objectComponentBaseBaseComponentTelerikDockManager
Implements:
Inherited Members
Constructors
TelerikDockManager()
Declaration
public TelerikDockManager()
Properties
DockManagerFloatingPanes
The floating panes of the DockManager. Children: DockManagerSplitPane.
Declaration
[Parameter]
public RenderFragment DockManagerFloatingPanes { get; set; }
Property Value
DockManagerPanes
The root panes of the DockManager. Children: DockManagerContentPane, DockManagerTabGroupPane, DockManagerSplitPane.
Declaration
[Parameter]
public RenderFragment DockManagerPanes { get; set; }
Property Value
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.
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.
Declaration
[Parameter]
public EventCallback<DockManagerDockEventArgs> OnDock { get; set; }
Property Value
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.
Declaration
[Parameter]
public EventCallback<DockManagerPaneResizeEventArgs> OnPaneResize { get; set; }
Property Value
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.
Declaration
[Parameter]
public EventCallback<DockManagerPinEventArgs> OnPin { get; set; }
Property Value
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.
Declaration
[Parameter]
public EventCallback<DockManagerStateEventArgs> OnStateChanged { get; set; }
Property Value
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.
Declaration
[Parameter]
public EventCallback<DockManagerStateEventArgs> OnStateInit { get; set; }
Property Value
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.
Declaration
[Parameter]
public EventCallback<DockManagerUndockEventArgs> OnUndock { get; set; }
Property Value
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.
Declaration
[Parameter]
public EventCallback<DockManagerUnpinEventArgs> OnUnpin { get; set; }
Property Value
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.
Declaration
[Parameter]
public DockManagerPaneOrientation Orientation { get; set; }
Property Value
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builder
Overrides
GetState()
Gets the current state of the DockManager.
Declaration
public DockManagerState GetState()
Returns
OnInitialized()
Declaration
protected override void OnInitialized()
Overrides
SetState(DockManagerState)
Sets the state of the DockManager.
Declaration
public void SetState(DockManagerState state)
Parameters
state