Class
TelerikDockManager

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:

cs-api-definition

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.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()

Declaration

cs-api-definition

public TelerikDockManager()

Properties

DockManagerFloatingPanes

The floating panes of the DockManager. Children: DockManagerSplitPane.

Declaration

cs-api-definition

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

Property Value

RenderFragment

DockManagerPanes

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

Declaration

cs-api-definition

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

Property Value

RenderFragment

Height

The height of the DockManager.

Declaration

cs-api-definition

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

Property Value

string

OnDock

The event that will be invoked when a pane is docked. The event is cancelable.

Declaration

cs-api-definition

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

Property Value

EventCallback<DockManagerDockEventArgs>

OnPaneResize

The event that will be invoked when a dock manager splitter pane is resized.

Declaration

cs-api-definition

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

Property Value

EventCallback<DockManagerPaneResizeEventArgs>

OnPin

The event that will be invoked when a pane is pinned. The event is cancelable.

Declaration

cs-api-definition

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

Property Value

EventCallback<DockManagerPinEventArgs>

OnStateChanged

The event that will be invoked when the dock manager state is changed.

Declaration

cs-api-definition

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

Property Value

EventCallback<DockManagerStateEventArgs>

OnStateInit

The event that will be invoked when the dock manager is initialized. Through the event arguments, you can access/modify the state of the dock manager.

Declaration

cs-api-definition

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

Property Value

EventCallback<DockManagerStateEventArgs>

OnUndock

The event that will be invoked when a pane is undocked. The event is cancelable.

Declaration

cs-api-definition

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

Property Value

EventCallback<DockManagerUndockEventArgs>

OnUnpin

The event that will be invoked when a pane is unpinned. The event is cancelable.

Declaration

cs-api-definition

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

Property Value

EventCallback<DockManagerUnpinEventArgs>

Orientation

The dock manager root splitter orientation. The possible values are Horizontal and Vertical. The default value is Horizontal.

Declaration

cs-api-definition

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

Property Value

DockManagerPaneOrientation

Width

The width of the DockManager.

Declaration

cs-api-definition

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

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

GetState()

Gets the current state of the DockManager.

Declaration

cs-api-definition

public DockManagerState GetState()

Returns

DockManagerState

DockManagerState.

OnAfterRenderAsync(bool)

Declaration

cs-api-definition

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

OnInitialized()

Declaration

cs-api-definition

protected override void OnInitialized()

Overrides ComponentBase.OnInitialized()

Refresh()

Refreshes the DockManager.

Declaration

cs-api-definition

public void Refresh()

SetState(DockManagerState)

Sets the state of the DockManager.

Declaration

cs-api-definition

public void SetState(DockManagerState state)

Parameters

state

DockManagerState

DockManagerState.

ClassTelerikDockManager

Class
TelerikDockManager