A powerful, flexible dock manager component for laying out, docking, undocking, pinning, and floating panes of content.
Inheritance
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbDockManager()Returns IgbDockManager
Properties
Section titled "Properties"IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererControl
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }Height
Section titled "Height"Inherited from: BaseRendererControl
[Parameter]
public string Height { get; set; }Width
Section titled "Width"Inherited from: BaseRendererControl
[Parameter]
public string Width { get; set; }Class
Section titled "Class"Inherited from: BaseRendererControl
[Parameter]
public string Class { get; set; }AdditionalAttributes
Section titled "AdditionalAttributes"Inherited from: BaseRendererControl
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererControl
protected virtual string ParentTypeName { get; }EventBehavior
Section titled "EventBehavior"Inherited from: BaseRendererControl
Gets or sets how events are bubbled up from JavaScript to Blazor.
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererControl
[Parameter]
public RenderFragment ChildContent { get; set; }RoundTripDateConversion
Section titled "RoundTripDateConversion"Inherited from: BaseRendererControl
Gets or sets what type of date conversion to make when round tripping dates.
[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererControl
protected virtual bool UseDirectRender { get; }DirectRenderElementName
Section titled "DirectRenderElementName"Inherited from: BaseRendererControl
protected virtual string DirectRenderElementName { get; }NeedsDynamicContent
Section titled "NeedsDynamicContent"Inherited from: BaseRendererControl
protected virtual bool NeedsDynamicContent { get; }UseCamelEnumValues
Section titled "UseCamelEnumValues"Inherited from: BaseRendererControl
protected virtual bool UseCamelEnumValues { get; }ActivePane
Section titled "ActivePane"Determines the active content pane.
[Parameter]
public IgbContentPane ActivePane { get; set; }AllowFloatingPanesResize
Section titled "AllowFloatingPanesResize"Whether floating panes can be resized.
[Parameter]
public bool AllowFloatingPanesResize { get; set; }AllowInnerDock
Section titled "AllowInnerDock"Whether docking inside a pane is allowed.
[Parameter]
public bool AllowInnerDock { get; set; }AllowMaximize
Section titled "AllowMaximize"Whether maximize action button is displayed for the panes.
[Parameter]
public bool AllowMaximize { get; set; }AllowRootDock
Section titled "AllowRootDock"Determines whether docking into the root-level pane is allowed. When set to true (default), panes can be docked directly into the root container. This is done by creating a new root pane and repositioning the existing root pane as a sibling to the newly docked content pane.
[Parameter]
public bool AllowRootDock { get; set; }AllowSplitterDock
Section titled "AllowSplitterDock"Whether docking over splitter is allowed
[Parameter]
public bool AllowSplitterDock { get; set; }AutoScrollConfig
Section titled "AutoScrollConfig"[Parameter]
public IgbScrollConfig AutoScrollConfig { get; set; }CloseBehavior
Section titled "CloseBehavior"Which panes get affected by close operations.
[Parameter]
public PaneActionBehavior CloseBehavior { get; set; }ContainedInBoundaries
Section titled "ContainedInBoundaries"Whether pane dragging stops when any of the pane's sides goes outside the DockManager’s bounds.
[Parameter]
public bool ContainedInBoundaries { get; set; }ContextMenuPosition
Section titled "ContextMenuPosition"Position to open the context menu.
[Parameter]
public ContextMenuPosition ContextMenuPosition { get; set; }DefaultEventBehavior
Section titled "DefaultEventBehavior"Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }DisableKeyboardNavigation
Section titled "DisableKeyboardNavigation"Disables all keyboard navigation within the dock manager.
[Parameter]
public bool DisableKeyboardNavigation { get; set; }DraggedPane
Section titled "DraggedPane"Determines the pane that is currently dragged.
[Parameter]
public IgbDockManagerPane DraggedPane { get; set; }DropPosition
Section titled "DropPosition"The drop position (pane) when docking.
[Parameter]
public IgbDockManagerPoint DropPosition { get; set; }EnableDragCursor
Section titled "EnableDragCursor"Enables changing the mouse cursor when hovering over a tab or pane header. When set to true, the cursor changes from the default to pointer, indicating that the header can be dragged (e.g., to dock or float the pane).
[Parameter]
public bool EnableDragCursor { get; set; }Layout
Section titled "Layout"The layout configuration of the Dock Manager.
[Parameter]
public IgbDockManagerLayout Layout { get; set; }MaximizedPane
Section titled "MaximizedPane"Determines the pane that is currently maximized.
[Parameter]
public IgbDockManagerPane MaximizedPane { get; set; }NavigationPaneMeta
Section titled "NavigationPaneMeta"Metadata for the pane-navigator overlay.
[Parameter]
public IgbPaneNavigatorMetadata NavigationPaneMeta { get; set; }ProximityDock
Section titled "ProximityDock"Determines whether docking indicators are displayed while docking
[Parameter]
public bool ProximityDock { get; set; }ResourceStrings
Section titled "ResourceStrings"The resource strings of the dock manager.
[Parameter]
public IgbDockManagerResourceStrings ResourceStrings { get; set; }ShowHeaderIconOnHover
Section titled "ShowHeaderIconOnHover"Which header icons are shown on hover.
[Parameter]
public DockManagerShowHeaderIconOnHover ShowHeaderIconOnHover { get; set; }ShowPaneHeaders
Section titled "ShowPaneHeaders"Determines when to display the pane headers - always or on hover of the pane.
[Parameter]
public DockManagerShowPaneHeaders ShowPaneHeaders { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"protected override bool SupportsVisualChildren { get; }UnpinBehavior
Section titled "UnpinBehavior"Determines which panes are affected by particular pane action such as closing or unpinning.
[Parameter]
public PaneActionBehavior UnpinBehavior { get; set; }UseFixedSizeOnDock
Section titled "UseFixedSizeOnDock"Specifies which docking orientations should apply the FixedSize sizing mode when panes are dynamically created via docking. Possible values: "none": Do not apply FixedSize on docking (default behavior). "vertical": Apply FixedSize only when panes are docked vertically. "horizontal": Apply FixedSize only when panes are docked horizontally. "both": Apply FixedSize for both vertical and horizontal orientation. This setting affects only dynamically created panes via user docking actions. It does not apply to programmatically created panes or layout restorations.
[Parameter]
public DockManagerUseFixedSizeOnDock UseFixedSizeOnDock { get; set; }Accessors
Section titled "Accessors"eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererControl
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererControl
protected string _cachedSerializedContentMethods
Section titled "Methods"ResolveEventBehavior()
Section titled "ResolveEventBehavior()"Inherited from: BaseRendererControl
Resolves the components event behavior if Auto is selected.
protected ControlEventBehavior ResolveEventBehavior()Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"Inherited from: BaseRendererControl
protected virtual string ResolveDisplay()Returns any
ToSpinal(string)
Section titled "ToSpinal(string)"Inherited from: BaseRendererControl
protected string ToSpinal(string value)Parameters
- value:
string
Returns any
TransformSimpleKey(string)
Section titled "TransformSimpleKey(string)"Inherited from: BaseRendererControl
protected virtual string TransformSimpleKey(string key)Parameters
- key:
string
Returns any
IsTransformedEnumValue(string)
Section titled "IsTransformedEnumValue(string)"Inherited from: BaseRendererControl
protected virtual bool IsTransformedEnumValue(string key)Parameters
- key:
string
Returns any
TransformPotentialEnumValue(string, object)
Section titled "TransformPotentialEnumValue(string, object)"Inherited from: BaseRendererControl
protected virtual object TransformPotentialEnumValue(string key, object value)Parameters
- key:
string - value:
object
Returns any
BuildSequenceInfo(int)
Section titled "BuildSequenceInfo(int)"Inherited from: BaseRendererControl
protected virtual SequenceInfo BuildSequenceInfo(int startSequence)Parameters
- startSequence:
int
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererControl
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
TemplateContentType(string)
Section titled "TemplateContentType(string)"Inherited from: BaseRendererControl
protected Type TemplateContentType(string templateId)Parameters
- templateId:
string
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"Inherited from: BaseRendererControl
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
EnsureReady()
Section titled "EnsureReady()"Inherited from: BaseRendererControl
public Task EnsureReady()Returns any
MarkPropDirty(string)
Section titled "MarkPropDirty(string)"Inherited from: BaseRendererControl
protected void MarkPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererControl
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererControl
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererControl
public string Serialize()Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
SuspendNotifications(object)
Section titled "SuspendNotifications(object)"Inherited from: BaseRendererControl
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications(object dataSource)Parameters
- dataSource:
object
Returns any
ResumeNotifications(object, bool)
Section titled "ResumeNotifications(object, bool)"Inherited from: BaseRendererControl
Resumes data change notifications.
public void ResumeNotifications(object dataSource, bool notify = true)Parameters
- dataSource:
object - notify:
bool
Returns any
NotifyInsertItem(object, int, object)
Section titled "NotifyInsertItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyInsertItem(object dataSource, int index, object refItem)Parameters
- dataSource:
object - index:
int - refItem:
object
Returns any
NotifyRemoveItem(object, int, object)
Section titled "NotifyRemoveItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyRemoveItem(object dataSource, int index, object oldItem)Parameters
- dataSource:
object - index:
int - oldItem:
object
Returns any
NotifyClearItems(object)
Section titled "NotifyClearItems(object)"Inherited from: BaseRendererControl
public void NotifyClearItems(object dataSource)Parameters
- dataSource:
object
Returns any
NotifySetItem(object, int, object, object)
Section titled "NotifySetItem(object, int, object, object)"Inherited from: BaseRendererControl
public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)Parameters
- dataSource:
object - index:
int - oldItem:
object - newItem:
object
Returns any
NotifyUpdateItem(object, int, object, bool)
Section titled "NotifyUpdateItem(object, int, object, bool)"Inherited from: BaseRendererControl
public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)Parameters
- dataSource:
object - index:
int - refItem:
object - syncDataOnly:
bool
Returns any
OnRefChanged(string, object)
Section titled "OnRefChanged(string, object)"Inherited from: BaseRendererControl
public void OnRefChanged(string refName, object refValue)Parameters
- refName:
string - refValue:
object
Returns any
OnInvokeReturn(long, object)
Section titled "OnInvokeReturn(long, object)"Inherited from: BaseRendererControl
public void OnInvokeReturn(long invokeId, object returnValue)Parameters
- invokeId:
long - returnValue:
object
Returns any
Camelize(string)
Section titled "Camelize(string)"Inherited from: BaseRendererControl
protected string Camelize(string value)Parameters
- value:
string
Returns any
ToPascal(string)
Section titled "ToPascal(string)"Inherited from: BaseRendererControl
protected string ToPascal(string value)Parameters
- value:
string
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererControl
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
Dispose(bool)
Section titled "Dispose(bool)"Inherited from: BaseRendererControl
protected virtual void Dispose(bool disposing)Parameters
- disposing:
bool
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
SetPropertyValue(object, PropertyInfo, JsonElement)
Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)Parameters
- item:
object - property:
PropertyInfo - jsonElement:
JsonElement
Returns any
SetPropertyValue(object, PropertyInfo, object)
Section titled "SetPropertyValue(object, PropertyInfo, object)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, object value)Parameters
- item:
object - property:
PropertyInfo - value:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: BaseRendererControl
public void Dispose()Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
FocusPane(string)
Section titled "FocusPane(string)"public void FocusPane(string contentId)Parameters
- contentId:
string
Returns any
FocusPaneAsync(string)
Section titled "FocusPaneAsync(string)"public Task FocusPaneAsync(string contentId)Parameters
- contentId:
string
Returns any
GetCurrentLayout()
Section titled "GetCurrentLayout()"public IgbDockManagerLayout GetCurrentLayout()Returns any
GetCurrentLayoutAsync()
Section titled "GetCurrentLayoutAsync()"public Task<IgbDockManagerLayout> GetCurrentLayoutAsync()Returns any
GetDirection()
Section titled "GetDirection()"public string GetDirection()Returns any
GetDirectionAsync()
Section titled "GetDirectionAsync()"public Task<string> GetDirectionAsync()Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"public void SetNativeElement(object element)Parameters
- element:
object
Returns any
SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
Events
Section titled "Events"ActivePaneChanged
Section titled "ActivePaneChanged"[Parameter]
public EventCallback<IgbActivePaneEventArgs> ActivePaneChanged { get; set; }FloatingPaneResizeEnd
Section titled "FloatingPaneResizeEnd"[Parameter]
public EventCallback<IgbFloatingPaneResizeEventArgs> FloatingPaneResizeEnd { get; set; }FloatingPaneResizeMove
Section titled "FloatingPaneResizeMove"[Parameter]
public EventCallback<IgbFloatingPaneResizeMoveEventArgs> FloatingPaneResizeMove { get; set; }FloatingPaneResizeStart
Section titled "FloatingPaneResizeStart"[Parameter]
public EventCallback<IgbFloatingPaneResizeEventArgs> FloatingPaneResizeStart { get; set; }LayoutChange
Section titled "LayoutChange"[Parameter]
public EventCallback<IgbLayoutChangeEventArgs> LayoutChange { get; set; }LayoutChanged
Section titled "LayoutChanged"[Parameter]
public EventCallback<IgbDockManagerLayout> LayoutChanged { get; set; }PaneClose
Section titled "PaneClose"[Parameter]
public EventCallback<IgbPaneCloseEventArgs> PaneClose { get; set; }PaneDragEnd
Section titled "PaneDragEnd"[Parameter]
public EventCallback<IgbPaneDragEndEventArgs> PaneDragEnd { get; set; }PaneDragOver
Section titled "PaneDragOver"[Parameter]
public EventCallback<IgbPaneDragOverEventArgs> PaneDragOver { get; set; }PaneDragStart
Section titled "PaneDragStart"[Parameter]
public EventCallback<IgbPaneDragStartEventArgs> PaneDragStart { get; set; }PaneFlyoutToggle
Section titled "PaneFlyoutToggle"[Parameter]
public EventCallback<IgbPaneFlyoutEventArgs> PaneFlyoutToggle { get; set; }PaneHeaderConnected
Section titled "PaneHeaderConnected"[Parameter]
public EventCallback<IgbPaneHeaderConnectionEventArgs> PaneHeaderConnected { get; set; }PaneHeaderDisconnected
Section titled "PaneHeaderDisconnected"[Parameter]
public EventCallback<IgbPaneHeaderConnectionEventArgs> PaneHeaderDisconnected { get; set; }PanePinnedToggle
Section titled "PanePinnedToggle"[Parameter]
public EventCallback<IgbPanePinnedEventArgs> PanePinnedToggle { get; set; }PaneScroll
Section titled "PaneScroll"[Parameter]
public EventCallback<IgbPaneScrollEventArgs> PaneScroll { get; set; }TabHeaderConnected
Section titled "TabHeaderConnected"[Parameter]
public EventCallback<IgbTabHeaderConnectionEventArgs> TabHeaderConnected { get; set; }TabHeaderDisconnected
Section titled "TabHeaderDisconnected"[Parameter]
public EventCallback<IgbTabHeaderConnectionEventArgs> TabHeaderDisconnected { get; set; }ActivePaneChangedScript
Section titled "ActivePaneChangedScript"[Parameter]
public string ActivePaneChangedScript { get; set; }FloatingPaneResizeEndScript
Section titled "FloatingPaneResizeEndScript"[Parameter]
public string FloatingPaneResizeEndScript { get; set; }FloatingPaneResizeMoveScript
Section titled "FloatingPaneResizeMoveScript"[Parameter]
public string FloatingPaneResizeMoveScript { get; set; }FloatingPaneResizeStartScript
Section titled "FloatingPaneResizeStartScript"[Parameter]
public string FloatingPaneResizeStartScript { get; set; }LayoutChangeScript
Section titled "LayoutChangeScript"[Parameter]
public string LayoutChangeScript { get; set; }PaneCloseScript
Section titled "PaneCloseScript"[Parameter]
public string PaneCloseScript { get; set; }PaneDragEndScript
Section titled "PaneDragEndScript"[Parameter]
public string PaneDragEndScript { get; set; }PaneDragOverScript
Section titled "PaneDragOverScript"[Parameter]
public string PaneDragOverScript { get; set; }PaneDragStartScript
Section titled "PaneDragStartScript"[Parameter]
public string PaneDragStartScript { get; set; }PaneFlyoutToggleScript
Section titled "PaneFlyoutToggleScript"[Parameter]
public string PaneFlyoutToggleScript { get; set; }PaneHeaderConnectedScript
Section titled "PaneHeaderConnectedScript"[Parameter]
public string PaneHeaderConnectedScript { get; set; }PaneHeaderDisconnectedScript
Section titled "PaneHeaderDisconnectedScript"[Parameter]
public string PaneHeaderDisconnectedScript { get; set; }PanePinnedToggleScript
Section titled "PanePinnedToggleScript"[Parameter]
public string PanePinnedToggleScript { get; set; }PaneScrollScript
Section titled "PaneScrollScript"[Parameter]
public string PaneScrollScript { get; set; }TabHeaderConnectedScript
Section titled "TabHeaderConnectedScript"[Parameter]
public string TabHeaderConnectedScript { get; set; }TabHeaderDisconnectedScript
Section titled "TabHeaderDisconnectedScript"[Parameter]
public string TabHeaderDisconnectedScript { get; set; }