CDockablePaneAdapter Class
The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.
The latest version of this topic can be found at CDockablePaneAdapter Class.
Provides docking support for CWnd-derived panes.
Syntax
class CDockablePaneAdapter : public CDockablePane
Members
Public Methods
| Name | Description |
|---|---|
| CDockablePaneAdapter::GetWrappedWnd | Returns the wrapped window. |
| CDockablePaneAdapter::LoadState | (Overrides CDockablePane::LoadState.) |
| CDockablePaneAdapter::SaveState | (Overrides CDockablePane::SaveState.) |
| CDockablePaneAdapter::SetWrappedWnd |
Remarks
Usually, the framework instantiates objects of this class when you use the CMFCBaseTabCtrl::AddTab or CMFCBaseTabCtrl::InsertTab methods.
If you want to customize the CDockablePaneAdapter behavior, just derive a new class from it and set the runtime class information to a tabbed window by using CMFCBaseTabCtrl::SetDockingBarWrapperRTC.
Inheritance Hierarchy
Requirements
Header: afxDockablePaneAdapter.h
CDockablePaneAdapter::GetWrappedWnd
Returns the underlying window for the dockable pane adapter.
virtual CWnd* GetWrappedWnd() const;
Return Value
A pointer to the wrapped window.
Remarks
Use this function to access the wrapped window.
CDockablePaneAdapter::LoadState
Loads the state of the pane from the registry.
virtual BOOL LoadState(
LPCTSTR lpszProfileName=NULL,
int nIndex=-1,
UINT uiID=(UINT)-1);
Parameters
[in] lpszProfileName
The profile name.
[in] nIndex
The profile index.
[in] uiID
The pane ID.
Return Value
Remarks
CDockablePaneAdapter::SaveState
Saves the state of the pane to the registry.
virtual BOOL SaveState(
LPCTSTR lpszProfileName=NULL,
int nIndex=-1,
UINT uiID=(UINT)-1);
Parameters
[in] lpszProfileName
The profile name.
[in] nIndex
The profile index (defaults to the control ID of the window).
[in] uiID
The pane ID.
Return Value
Remarks
CDockablePaneAdapter::SetWrappedWnd
Sets the underlying window for the dockable pane adapter.
virtual BOOL SetWrappedWnd(CWnd* pWnd);
Parameters
[in] pWnd
A pointer to the window for the pane adapter to wrap.