KryptonDockingManager Class |
Manages a hierarchy of docking elements to provide docking windows functionality.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
Internal.ComponentFactory.Krypton.DockingDockingElement
Internal.ComponentFactory.Krypton.DockingDockingElementClosedCollection
Internal.ComponentFactory.Krypton.DockingDockingElementOpenCollection
Internal.ComponentFactory.Krypton.DockingKryptonDockingManager
SystemMarshalByRefObject
System.ComponentModelComponent
Internal.ComponentFactory.Krypton.DockingDockingElement
Internal.ComponentFactory.Krypton.DockingDockingElementClosedCollection
Internal.ComponentFactory.Krypton.DockingDockingElementOpenCollection
Internal.ComponentFactory.Krypton.DockingKryptonDockingManager
Namespace: Internal.ComponentFactory.Krypton.Docking
Assembly: NeoAxis.Core.Editor (in NeoAxis.Core.Editor.dll) Version: 2024.1.1.0 (2024.1.1.0)
SyntaxC#
public class KryptonDockingManager : DockingElementOpenCollection
The KryptonDockingManager type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | KryptonDockingManager |
Initialize a new instance of the KryptonDockingManager class.
|
| KryptonDockingManager(String) |
Initialize a new instance of the KryptonDockingManager class.
|
Properties| Name | Description | |
|---|---|---|
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) |
 | Cells |
Gets an array of all the cells inside the docking hierarchy.
|
| CellsDocked |
Gets an array of all the cells docked inside the docking hierarchy.
|
| CellsFloating |
Gets an array of all the cells floating inside the docking hierarchy.
|
| CellsWorkspace |
Gets an array of all the cells inside a dockable workspace inside the docking hierarchy.
|
| Container | Gets the IContainer that contains the Component. (Inherited from Component.) |
| Count |
Gets the number of child docking elements.
(Inherited from DockingElementClosedCollection.) |
| DefaultCloseRequest |
Gets and sets the default request action to use for a close.
|
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) |
| DockingManager |
Finds the KryptonDockingManager instance that owns this part of the docking hieararchy.
(Inherited from DockingElement.) |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) |
| HasDockManager |
Returns a value indicating if this docking element has access to a parent docking manager.
(Inherited from DockingElement.) |
| ItemInt32 |
Gets the docking element at the specified index.
(Inherited from DockingElementClosedCollection.) |
| ItemString |
Gets the docking element with the specified name.
(Inherited from DockingElementClosedCollection.) |
| Name |
Gets and sets the name of the docking element.
(Inherited from DockingElement.) |
| Pages |
Gets an array of all the pages inside the docking hierarchy.
|
| PagesAutoHidden |
Gets an array of all the pages auto hidden inside the docking hierarchy.
|
| PagesDocked |
Gets an array of all the pages docked inside the docking hierarchy.
|
| PagesFloating |
Gets an array of all the pages floating inside the docking hierarchy.
|
| PagesWorkspace |
Gets an array of all the pages inside a dockable workspace inside the docking hierarchy.
|
| Parent |
Gets and sets access to the parent docking element.
(Inherited from DockingElement.) |
| Path |
Gets a comma separated list of names leading to this element.
(Inherited from DockingElement.) |
| Site | (Inherited from Component.) |
| Strings |
Gets access to the set of display strings required of the docking hierarchy display elements.
|
| XmlElementName |
Gets the xml element name to use when saving.
(Overrides DockingElementXmlElementName.) |
Methods| Name | Description | |
|---|---|---|
| Add |
Append a docking element to the collection.
(Inherited from DockingElementOpenCollection.) |
| AddAutoHiddenGroup |
Add set of pages as a new auto hidden group to the specified edge of the specified control.
|
| AddDockspace |
Add set of pages docked against a specified edge of the specified control.
|
| AddFloatingWindow(String, KryptonPage) |
Add set of pages as a new floating window.
|
| AddFloatingWindow(String, KryptonPage, Point) |
Add set of pages as a new floating window.
|
| AddFloatingWindow(String, KryptonPage, Size) |
Add set of pages as a new floating window.
|
| AddFloatingWindow(String, KryptonPage, Point, Size) |
Add set of pages as a new floating window.
|
| AddToNavigator |
Add set of pages to a docking navigator.
|
| AddToWorkspace |
Add set of pages to a docking workspace.
|
| Clear |
Remove all docking elements from the collection.
(Inherited from DockingElementOpenCollection.) |
| ClearAllStoredPages |
Cleat away all store pages.
|
| ClearStoredPages(String) |
Clear away any store pages for the provided unique named pages.
|
| ClearStoredPages(KryptonPage) |
Clear away any store pages for the provided pages.
|
| CloseRequest |
Perform the close request for a set of named pages.
|
| Contains |
Determines whether the collection contains the docking element.
(Inherited from DockingElementClosedCollection.) |
| ContainsPage(String) |
Determines if the provided page is present in the docking hierarchy.
|
| ContainsPage(KryptonPage) |
Determines if the provided page is present in the docking hierarchy.
|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| DemandDockingManager |
Checks that this element has access to a docking manager, throwing exception if not.
(Inherited from DockingElement.) |
| DemandPagesNotBePresent |
Checks that the provided set of pages are not already present in the docking hierarchy.
(Inherited from DockingElement.) |
| Dispose | Releases all resources used by the Component. (Inherited from Component.) |
 | Dispose(Boolean) | Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.) |
| DoDragDrop(Point, Point, Control, KryptonDockingFloatingWindow) |
Generate an implementation of the IDragPageNotify class that will be used to handle the drag/drop operation.
|
| DoDragDrop(Point, Point, Control, KryptonPageCollection) |
Generate an implementation of the IDragPageNotify class that will be used to handle the drag/drop operation.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.) |
| FindDockingEdgeAutoHidden |
Find a edge auto hidden element by searching the hierarchy.
(Overrides DockingElementFindDockingEdgeAutoHidden(String).) |
| FindDockingEdgeDocked |
Find a edge docked element by searching the hierarchy.
(Overrides DockingElementFindDockingEdgeDocked(String).) |
| FindDockingFloating |
Find a floating docking element by searching the hierarchy.
(Overrides DockingElementFindDockingFloating(String).) |
| FindDockingNavigator |
Find a navigator element by searching the hierarchy.
(Inherited from DockingElement.) |
| FindDockingWorkspace |
Find a workspace element by searching the hierarchy.
(Overrides DockingElementFindDockingWorkspace(String).) |
| FindPageElement(String) |
Find the docking element that contains the named page.
(Overrides DockingElementFindPageElement(String).) |
| FindPageElement(KryptonPage) |
Find the docking element that contains the provided page.
|
| FindPageLocation(String) |
Find the docking location of the named page.
(Overrides DockingElementFindPageLocation(String).) |
| FindPageLocation(KryptonPage) |
Find the docking location of the provided page.
|
| FindStorePageElement(DockingLocation, KryptonPage) |
Find the docking element that contains the location specific store page for the named page.
|
| FindStorePageElement(DockingLocation, String) |
Find the docking element that contains the location specific store page for the named page.
(Overrides DockingElementFindStorePageElement(DockingLocation, String).) |
| GetEnumerator |
Shallow enumerate over child docking elements.
(Inherited from DockingElementClosedCollection.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetParentType |
Search up the parent chain looking for the specified type of object.
(Inherited from DockingElement.) |
| GetService | (Inherited from Component.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HideAllPages |
Hide all display elements of all pages.
|
| HidePage(String) |
Hide all display elements of the provided page.
|
| HidePage(KryptonPage) |
Hide all display elements of the provided page.
|
| HidePages(String) |
Hide all display elements of the provided pages.
|
| HidePages(KryptonPage) |
Hide all display elements of the provided pages.
|
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| Insert |
Append a docking element to the collection.
(Inherited from DockingElementOpenCollection.) |
| InsertAutoHiddenGroup |
Add set of pages as a new auto hidden group to the specified edge of the specified control.
|
| InsertDockspace |
Add set of pages docked against a specified edge of the specified control.
|
| InternalAdd |
Append a docking element to the collection.
(Inherited from DockingElementClosedCollection.) |
| InternalClear |
Remove all docking elements from the collection.
(Inherited from DockingElementClosedCollection.) |
| InternalInsert |
Insert a docking element to the collection.
(Inherited from DockingElementClosedCollection.) |
| InternalRemove |
Removes first occurance of specified docking element.
(Inherited from DockingElementClosedCollection.) |
| IsPageShowing(String) |
Determines if the provided page is present and showing.
|
| IsPageShowing(KryptonPage) |
Determines if the provided page is present and showing.
|
| LoadChildDockingElement |
Perform docking element specific actions for loading a child xml.
(Inherited from DockingElement.) |
| LoadConfigFromArray(Byte) |
Loads docking configuration information from given array of bytes.
|
| LoadConfigFromArray(String) |
Loads docking configuration information from given filename.
|
| LoadConfigFromFile |
Loads docking configuration information from given filename.
|
| LoadConfigFromStream |
Loads docking configuration information from given stream object.
|
| LoadConfigFromXml |
Loads docking configuration information using the provided xml reader.
|
| LoadDockingElement |
Perform docking element specific actions based on the loading xml.
(Inherited from DockingElement.) |
| LoadElementFromXml |
Loads docking configuration information using a provider xml reader.
(Inherited from DockingElement.) |
| MakeAutoHiddenRequest |
Make the named page auto hidden.
|
| MakeDockedRequest |
Make the named page docked.
|
| MakeFloatingRequest |
Make the named page floating.
|
| MakeNavigatorRequest |
Make the named page navigator tabbed.
|
| MakeWorkspaceRequest |
Make the named page workspace tabbed.
|
| ManageControl(Control) |
Manage auto hidden/docked capabilities for provided control.
|
| ManageControl(String, Control) |
Manage auto hidden/docked capabilities for provided control.
|
| ManageControl(Control, KryptonDockingNavigator) |
Manage auto hidden/docked capabilities for provided control.
|
| ManageControl(Control, KryptonDockingWorkspace) |
Manage auto hidden/docked capabilities for provided control.
|
| ManageControl(String, Control, KryptonDockingNavigator) |
Manage auto hidden/docked capabilities for provided control.
|
| ManageControl(String, Control, KryptonDockingWorkspace) |
Manage auto hidden/docked capabilities for provided control.
|
| ManageFloating(Form) |
Manage floating windows capability for provided form.
|
| ManageFloating(String, Form) |
Manage floating windows capability for provided form.
|
| ManageNavigator(KryptonDockableNavigator) |
Manage docking capability for provided dockable navigator control.
|
| ManageNavigator(String, KryptonDockableNavigator) |
Manage docking capability for provided dockable navigator control.
|
| ManageNavigator(String, String, KryptonDockableNavigator) |
Manage docking capability for provided dockable navigator control.
|
| ManageWorkspace(KryptonDockableWorkspace) |
Manage docking capability for provided dockable workspace control.
|
| ManageWorkspace(String, KryptonDockableWorkspace) |
Manage docking capability for provided dockable workspace control.
|
| ManageWorkspace(String, String, KryptonDockableWorkspace) |
Manage docking capability for provided dockable workspace control.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| OnAutoHiddenGroupAdding |
Raises the AutoHiddenGroupAdding event.
|
| OnAutoHiddenGroupPanelAdding |
Raises the AutoHiddenGroupPanelAdding event.
|
| OnAutoHiddenGroupPanelRemoved |
Raises the AutoHiddenGroupPanelRemoved event.
|
| OnAutoHiddenGroupRemoved |
Raises the AutoHiddenGroupRemoved event.
|
| OnAutoHiddenSeparatorResize |
Raises the AutoHiddenSeparatorResize event.
|
| OnAutoHiddenShowingStateChanged |
Raises the AutoHiddenShowingStateChanged event.
|
| OnDockableNavigatorAdded |
Raises the DockableNavigatorAdded event.
|
| OnDockableNavigatorRemoved |
Raises the DockableNavigatorRemoved event.
|
| OnDockableWorkspaceAdded |
Raises the DockableWorkspaceAdded event.
|
| OnDockableWorkspaceCellAdding |
Raises the DockableWorkspaceCellAdding event.
|
| OnDockableWorkspaceCellRemoved |
Raises the DockableWorkspaceCellRemoved event.
|
| OnDockableWorkspaceRemoved |
Raises the DockableWorkspaceRemoved event.
|
| OnDockspaceAdding |
Raises the DockspaceAdding event.
|
| OnDockspaceCellAdding |
Raises the DockspaceCellAdding event.
|
| OnDockspaceCellRemoved |
Raises the DockspaceCellRemoved event.
|
| OnDockspaceRemoved |
Raises the DockspaceRemoved event.
|
| OnDockspaceSeparatorAdding |
Raises the DockspaceSeparatorAdding event.
|
| OnDockspaceSeparatorRemoved |
Raises the DockspaceSeparatorRemoved event.
|
| OnDockspaceSeparatorResize |
Raises the DockspaceSeparatorResize event.
|
| OnDoDragDropEnd |
Raises the DoDragDropEnd event.
|
| OnDoDragDropQuit |
Raises the DoDragDropQuit event.
|
| OnFloatingWindowAdding |
Raises the FloatingWindowAdding event.
|
| OnFloatingWindowRemoved |
Raises the FloatingWindowRemoved event.
|
| OnFloatspaceAdding |
Raises the FloatspaceAdding event.
|
| OnFloatspaceCellAdding |
Raises the FloatspaceCellAdding event.
|
| OnFloatspaceCellRemoved |
Raises the FloatspaceCellRemoved event.
|
| OnFloatspaceRemoved |
Raises the FloatspaceRemoved event.
|
| OnGlobalLoading |
Raises the GlobalLoading event.
|
| OnGlobalSaving |
Raises the GlobalSaving event.
|
| OnOrphanedPages |
Raises the OrphanedPages event.
|
| OnPageAutoHiddenRequest |
Raises the PageAutoHiddenRequest event.
|
| OnPageCloseRequest |
Raises the PageCloseRequest event.
|
| OnPageDockedRequest |
Raises the PageDockedRequest event.
|
| OnPageFloatingRequest |
Raises the PageFloatingRequest event.
|
| OnPageLoading |
Raises the PageLoading event.
|
| OnPageNavigatorRequest |
Raises the PageNavigatorRequest event.
|
| OnPageSaving |
Raises the PageSaving event.
|
| OnPageWorkspaceRequest |
Raises the PageWorkspaceRequest event.
|
| OnRecreateLoadingPage |
Raises the RecreateLoadingPage event.
|
| OnShowPageContextMenu |
Raises the ShowPageContextMenu event.
|
| OnShowWorkspacePageContextMenu |
Raises the ShowWorkspacePageContextMenu event.
|
| PageForUniqueName |
Find the page reference that has the requested unique name.
|
| PropogateAction(DockingPropogateAction, KryptonPage) |
Propogates an action request down the hierarchy of docking elements.
(Inherited from DockingElement.) |
| PropogateAction(DockingPropogateAction, Int32) |
Propogates an action request down the hierarchy of docking elements.
(Inherited from DockingElement.) |
| PropogateAction(DockingPropogateAction, String) |
Propogates an action request down the hierarchy of docking elements.
(Inherited from DockingElement.) |
| PropogateBoolState |
Propogates a boolean state request down the hierarchy of docking elements.
(Inherited from DockingElement.) |
| PropogateCellList |
Propogates a workspace cell list request down the hierarchy of docking elements.
(Inherited from DockingElement.) |
| PropogateDragTargets |
Propogates a request for drag targets down the hierarchy of docking elements.
(Inherited from DockingElement.) |
| PropogateIntState |
Propogates an integer state request down the hierarchy of docking elements.
(Inherited from DockingElement.) |
| PropogatePageList |
Propogates a page list request down the hierarchy of docking elements.
(Inherited from DockingElement.) |
| PropogatePageState |
Propogates a page request down the hierarchy of docking elements.
(Inherited from DockingElement.) |
| Remove |
Removes first occurance of specified docking element.
(Inherited from DockingElementOpenCollection.) |
| RemoveAllPages |
Remove all pages.
|
| RemovePage(String, Boolean) |
Remove the named page.
|
| RemovePage(KryptonPage, Boolean) |
Remove the referenced page.
|
| RemovePages(String, Boolean) |
Remove the named pages.
|
| RemovePages(KryptonPage, Boolean) |
Remove the referenced pages.
|
| ResolvePath |
Resolve the provided path.
(Overrides DockingElementResolvePath(String).) |
| SaveConfigToArray |
Saves docking configuration information into an array of bytes using Unicode Encoding.
|
| SaveConfigToArray(Encoding) |
Saves docking configuration information into an array of bytes.
|
| SaveConfigToFile(String) |
Saves docking configurationt information into a named file using Unicode Encoding.
|
| SaveConfigToFile(String, Encoding) |
Saves docking configuration information into a named file.
|
| SaveConfigToStream |
Saves docking configuration information into a stream object.
|
| SaveConfigToXml |
Saves docking configuration information using a provider xml writer.
|
| SaveElementToXml |
Saves docking configuration information using a provider xml writer.
(Inherited from DockingElement.) |
| ShowAllPages |
Show all display elements of all pages.
|
| ShowPage(String) |
Show all display elements of the provided page.
|
| ShowPage(KryptonPage) |
Show all display elements of the provided page.
|
| ShowPageContextMenuRequest |
Populate a context menu appropriate for a non-dockable workspace provided page.
|
| ShowPages(String) |
Show all display elements of the provided pages.
|
| ShowPages(KryptonPage) |
Show all display elements of the provided pages.
|
| StoreAllPages |
Replace all pages with store placeholders so they can be restored at a later time.
|
| StorePage(String) |
Replace page with a store placeholder so it can be restored at a later time.
|
| StorePage(KryptonPage) |
Replace named page with a store placeholder so it can be restored at a later time.
|
| StorePages(String) |
Replace pages with store placeholders so they can be restored at a later time.
|
| StorePages(KryptonPage) |
Replace named pages with store placeholders so they can be restored at a later time.
|
| SwitchAutoHiddenGroupToDockedCellRequest |
Perform a switch from auto hidden group to docked cell for the visible pages inside the group.
|
| SwitchDockedCellToAutoHiddenGroupRequest |
Perform a switch from docked cell to auto hidden group for the visible pages inside the cell.
|
| SwitchDockedToFloatingWindowRequest |
Perform a switch from docked pages to floating window for the named pages.
|
| SwitchFloatingToDockedRequest |
Perform a switch from floating to docked for the named pages.
|
| SwitchFloatingToFloatingWindowRequest |
Perform a switch from floating to new floating window for the named pages.
|
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) |
Events| Name | Description | |
|---|---|---|
 | AutoHiddenGroupAdding |
Occurs when a new auto hidden group is being added.
|
| AutoHiddenGroupPanelAdding |
Occurs when a new panel for hosting auto hidden groups is being added.
|
| AutoHiddenGroupPanelRemoved |
Occurs when an existing panel for hosting auto hidden groups is being removed.
|
| AutoHiddenGroupRemoved |
Occurs when an existing auto hidden group is being removed.
|
| AutoHiddenSeparatorResize |
Occurs when a separator is used to resize an auto hidden dockspace.
|
| AutoHiddenShowingStateChanged |
Occurs when an auto hidden page showing state changes.
|
| Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.) |
| DockableNavigatorAdded |
Occurs when a new dockable navigator control is being addd.
|
| DockableNavigatorRemoved |
Occurs when an existing dockable navigator control is being removed.
|
| DockableWorkspaceAdded |
Occurs when a new dockable workspace control is being addd.
|
| DockableWorkspaceCellAdding |
Occurs when a new dockable workspace control cell is being added.
|
| DockableWorkspaceCellRemoved |
Occurs when an existing dockable workspace control cell is being removed.
|
| DockableWorkspaceRemoved |
Occurs when an existing dockable workspace control is being removed.
|
| DockspaceAdding |
Occurs when a new dockspace control is being added.
|
| DockspaceCellAdding |
Occurs when a new dockspace control cell is being added.
|
| DockspaceCellRemoved |
Occurs when an existing dockspace control cell is being removed.
|
| DockspaceRemoved |
Occurs when an existing dockspace control is being removed.
|
| DockspaceSeparatorAdding |
Occurs when a new dockspace separator control is being added.
|
| DockspaceSeparatorRemoved |
Occurs when an existing dockspace separator control is being removed.
|
| DockspaceSeparatorResize |
Occurs when a separator is used to resize a docked dockspace.
|
| DoDragDropEnd |
Occurs when a drag drop operation has ended with success.
|
| DoDragDropQuit |
Occurs when a drag drop operation has been quit.
|
| FloatingWindowAdding |
Occurs when a new floating window is being added.
|
| FloatingWindowRemoved |
Occurs when an existing floating window is being removed.
|
| FloatspaceAdding |
Occurs when a new floatspace control is being added.
|
| FloatspaceCellAdding |
Occurs when a new floatspace control cell is being added.
|
| FloatspaceCellRemoved |
Occurs when an existing floatspace control cell is being removed.
|
| FloatspaceRemoved |
Occurs when an existing floatspace control is being removed.
|
| GlobalLoading |
Occurs when global docking configuration information is loading.
|
| GlobalSaving |
Occurs when global docking configuration information is saving.
|
| OrphanedPages |
Occurs when docking configuration information is loaded and existing pages have become orphaned because they are not used in the incoming configuration.
|
| PageAutoHiddenRequest |
Occurs when the user requests a page become auto hidden.
|
| PageCloseRequest |
Occurs when the user requests a page be closed.
|
| PageDockedRequest |
Occurs when the user requests a page become docked.
|
| PageFloatingRequest |
Occurs when the user requests a page become floating.
|
| PageLoading |
Occurs when page docking configuration information is loading.
|
| PageNavigatorRequest |
Occurs when the user requests a page become navigator tabbed.
|
| PageSaving |
Occurs when page docking configuration information is saving.
|
| PageWorkspaceRequest |
Occurs when the user requests a page become workspace tabbed.
|
| RecreateLoadingPage |
Occurs when docking configuration information is loading and a page needs creating to match incoming unique name.
|
| ShowPageContextMenu |
Occurs when a docking context menu is about to be shown for a page.
|
| ShowWorkspacePageContextMenu |
Occurs when a dockable workspace context menu is about to be shown for a page.
|
Extension Methods| Name | Description | |
|---|---|---|
 | MethodInvoke |
Calls the object method by name.
(Defined by ObjectEx.) |
| PropertyGet(String, Object, Boolean) | Overloaded.
Gets the value of the object property by name.
(Defined by ObjectEx.) |
| PropertyGetT(String, Object, Boolean) | Overloaded.
Gets the value of the object property by name.
(Defined by ObjectEx.) |
| PropertySet |
Sets the value of the object property by name.
(Defined by ObjectEx.) |
See Also