Class IgbDockManager

Describes a Dock Manager component.

Inheritance
System.Object
BaseRendererControl
IgbDockManager
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbDockManager : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbDockManager()

Declaration
public IgbDockManager()

Properties

ActivePane

Gets/sets the active pane of the Dock Manager.

Declaration
public IgbContentPane ActivePane { get; set; }
Property Value
Type Description
IgbContentPane

AllowFloatingPanesResize

Determines whether the end user is allowed to resize floating panes. Defaults to true.

Declaration
public bool AllowFloatingPanesResize { get; set; }
Property Value
Type Description
System.Boolean

AllowInnerDock

Determines whether the end user is allowed to inner dock panes. Defaults to true.

Declaration
public bool AllowInnerDock { get; set; }
Property Value
Type Description
System.Boolean

AllowMaximize

Determines whether the end user is allowed to maximize panes. Defaults to true.

Declaration
public bool AllowMaximize { get; set; }
Property Value
Type Description
System.Boolean

AllowSplitterDock

Determines whether the end user can dock the dragged pane directly in the parent split pane by dragging it over a splitter. If enabled, a docking indicator will be shown over the splitter's drag handler. Defaults to false.

Declaration
public bool AllowSplitterDock { get; set; }
Property Value
Type Description
System.Boolean

CloseBehavior

Determines whether the selected pane or all panes are closed when clicking the close button of a pane within a dockable TabGroup. Defaults to 'allPanes'.

Declaration
public PaneActionBehavior CloseBehavior { get; set; }
Property Value
Type Description
PaneActionBehavior

ContainedInBoundaries

Determines whether the floating panes are kept inside the Dock Manager boundaries. Defaults to false.

Declaration
public bool ContainedInBoundaries { get; set; }
Property Value
Type Description
System.Boolean

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

DisableKeyboardNavigation

Disables the built-in keyboard shortcuts for pane navigation. Defaults to false.

Declaration
public bool DisableKeyboardNavigation { get; set; }
Property Value
Type Description
System.Boolean

DraggedPane

Gets/sets the currently dragged pane.

Declaration
public IgbDockManagerPane DraggedPane { get; set; }
Property Value
Type Description
IgbDockManagerPane

DropPosition

Gets/sets the current drop position when performing custom drag/drop.

Declaration
public IgbDockManagerPoint DropPosition { get; set; }
Property Value
Type Description
IgbDockManagerPoint

Layout

Gets/sets the layout configuration of the Dock Manager.

Declaration
public IgbDockManagerLayout Layout { get; set; }
Property Value
Type Description
IgbDockManagerLayout

LayoutChange

Declaration
public EventCallback<IgbLayoutChangeEventArgs> LayoutChange { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbLayoutChangeEventArgs>

LayoutChanged

Declaration
public EventCallback<IgbDockManagerLayout> LayoutChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbDockManagerLayout>

LayoutChangeScript

Declaration
public string LayoutChangeScript { get; set; }
Property Value
Type Description
System.String

MaximizedPane

Gets/sets the maximized pane.

Declaration
public IgbDockManagerPane MaximizedPane { get; set; }
Property Value
Type Description
IgbDockManagerPane

ProximityDock

Determines whether the end user can dock the dragged pane by dragging it close to the target pane edges. If enabled, docking indicators are not visible. Defaults to false.

Declaration
public bool ProximityDock { get; set; }
Property Value
Type Description
System.Boolean

ResourceStrings

Gets/sets the resource strings.

Declaration
public IgbDockManagerResourceStrings ResourceStrings { get; set; }
Property Value
Type Description
IgbDockManagerResourceStrings

ShowHeaderIconOnHover

Determines which tab header icons should show when hovering over the tab with the mouse. Defaults to none.

Declaration
public DockManagerShowHeaderIconOnHover ShowHeaderIconOnHover { get; set; }
Property Value
Type Description
DockManagerShowHeaderIconOnHover

ShowPaneHeaders

Determines whether pane headers are only shown on hover or always visible. Defaults to 'always'.

Declaration
public DockManagerShowPaneHeaders ShowPaneHeaders { get; set; }
Property Value
Type Description
DockManagerShowPaneHeaders

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UnpinBehavior

Determines whether the selected pane or all panes are unpinned when clicking the unpin button of a pane within a dockable TabGroup. Defaults to 'allPanes'.

Declaration
public PaneActionBehavior UnpinBehavior { get; set; }
Property Value
Type Description
PaneActionBehavior

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

FocusPane(String)

Declaration
public void FocusPane(string contentId)
Parameters
Type Name Description
System.String contentId

FocusPaneAsync(String)

Focuses a pane from the layout.

Declaration
public Task FocusPaneAsync(string contentId)
Parameters
Type Name Description
System.String contentId
Returns
Type Description
System.Threading.Tasks.Task

GetCurrentLayout()

Declaration
public IgbDockManagerLayout GetCurrentLayout()
Returns
Type Description
IgbDockManagerLayout

GetCurrentLayoutAsync()

Declaration
public Task<IgbDockManagerLayout> GetCurrentLayoutAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbDockManagerLayout>

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable