Skip to content

DockingPaneFrame Control Members

See Also

DockingPaneFrame Overview

See Also

DockingPaneFrame Control Members

Public Methods

Public Method AboutBox
Public Method AddIconHandle
Public Method AttachPane
Public Method AttachToWindow
Public Method CloseAll
Public Method CreateLayout
CreateLayout method creates a DockingPaneLayout object to store a docking pane state/layout. The DockingPaneLayout object created is used with the GetLayout and SetLayout methods to load and set docking pane layouts.
Public Method CreatePane
Public Method DestroyAll
Public Method DestroyPane
Public Method DockPane
Public Method DockSidePane
Side docking is enabled.
Public Method EnableKeyboardNavigate
Public Method FindPane
Finds and returns the specified docking pane, searching by pane Id.
Public Method FloatPane
Public Method GetClientRect
Public Method GetLayout
GetLayout method retrieves the currently used docking pane layout.
Public Method HidePane
Public Method LoadState
Public Method LoadStateFromString
Public Method NormalizeSplitters
Public Method RecalcLayout
Public Method RedrawPanes
Public Method SaveState
Public Method SaveStateToString
Public Method SetCommandBars
Public Method SetLayout
SetLayout method sets the layout of the docking panes. The SetLayout method sets a state/layout saved by the GetLayout method.
Public Method SetMDIClient
Public Method ShowPane
Public Method UpdatePanes

Method Description
AboutBox Displays a dialog box that specifies the current version of the control.
AddIconHandle Adds an icon to be used in the docking pane tabs.
AttachPane Call this member to attach a pane to another pane creating a group of panes.
AttachToWindow Specifies the control that will contain the Docking Panes.
CloseAll Closes all panes.
CreateLayout Call this member function to create a docking pane.
DestroyAll Destroys all panes.
DestroyPane Destroys the specified pane.
DockPane Moves/docks an existing pane to another side of an application or pane.
DockSidePane Docks a pane to an inside edge of the client area when side docking is enabled.
EnableKeyboardNavigate Specifies the keyboard keys that can be used to navigate the docking panes.
FindPane Finds and returns the specified docking pane, searching by pane Id.
FloatPane Floats the specified pane and resizes the pane with the given dimensions.
GetClientRect Retrieves the dimensions of the client rectangle, that is, the area on the form which does not have any docking panes. This is needed so you know where the docking panes can be drawn.
HidePane Call this member to hide a pane.
LoadState Loads the pane layout from the registry.
LoadStateFromString Loads the pane layout from a string.
NormalizeSplitters Used to remember the location of splitters.
RecalcLayout Recalculates the entire layout of the docking panes on the form.
RedrawPanes Redraws the panes.
SaveState Saves the pane layout to the registry.
SaveStateToString Saves the pane layout to a string.
SetCommandBars Sets a CommandBars object to associate with this Docking Pane object.
SetLayout Sets the layout of the docking panes.
SetMDIClient Used in .NET to set handle to MDI client window.
ShowPane Call this member to show (activate) a pane by its identifier.
UpdatePanes Updates the state of the panes.

Public Properties

Public Property ActivePane
ActivePane property holds a reference to the currently active Pane.
Public Property Icons
Public Property ImageList
Public Property Layout
Public Property Options
Public Property PaintManager
PaintManager object is used to hold various pane painting properties.
Public Property PanelPaintManager
The panel paint manager is used to customize the appearance of your docking pane auto hide panel. The auto hide panel is displayed when you hide your docking panes.
Public Property Panes
Public Property PanesCount
Public Property ReCreateReparented
Public Property ScaleMode
Public Property TabPaintManager
The tab paint manager is used to customize the appearance of your docking pane tabs when the docking pane is NOT hidden.
Public Property ToolTipContext
ToolTipContext object represents the tool tip window that is used to display tool tips.
Public Property VisualTheme

Property Description
ActivePane A reference to the currently active pane.
Icons A collection of icons stored in an ImageManager control. This allows you to use images stored in the CommandBars ImageManager control in your docking pane tabs. The images from the ImageManager are displayed in the docking pane tabs.
ImageList Sets/Gets the imagelist associated with DockingPanes.
Layout Used to store a docking pane layout.
Options Gets/Sets the options of the docking pane.
PaintManager Holds various pane painting properties.
PanelPaintManager Used to customize the appearance of your docking pane auto hide panel.
Panes The DockingPaneManager's collection of panes.
PanesCount Gets the count of the total number of panes present.
ReCreateReparented Used to change the Docking Pane's measurement units/coordinate system.
ScaleMode Gets/Sets the visual theme which is used by the docking panes.
TabPaintManager Used to customize the appearance of your docking pane tabs when the docking pane is NOT hidden.
ToolTipContext Represents the tool tip window that is used to display tool tips.
VisualTheme Gets/Sets the visual theme which is used by the docking panes.

Events

Public Event Action
Public Event AttachPane
Public Event GetClientBordersWidth
Public Event PanePopupMenu
Menu Button is pressed.
Public Event RClick
RClick event occurs when the user right-clicks anywhere on the pane caption or on the tab button of a pane.
Public Event ReCreated
Public Event Resize
Public Event ResizeClient

Event Description
Action Occurs when a docking pane is performing an action.
AttachPane Occurs once when a pane is about to be displayed.
GetClientBordersWidth Occurs when the docking pane layout changes.
PanePopupMenu Occurs when the pane caption is clicked.
RClick Occurs when the user right-clicks anywhere on the pane caption or on the tab button of a pane.
ReCreated Occurs when the docking pane layout changes.
Resize Occurs when the docking pane layout changes.
ResizeClient Occurs when the docking pane layout changes.

See Also

DockingPaneFrame Overview

Copyright (c) 1998-2024 Codejock Technologies. All rights reserved.