CMultiPaneFrameWnd 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 CMultiPaneFrameWnd Class.
The CMultiPaneFrameWnd class extends CPaneFrameWnd Class. It can support multiple panes. Instead of a single embedded handle to a control bar, CMultiPaneFrameWnd contains a CPaneContainerManager Class object that enables the user to dock one CMultiPaneFrameWnd to another and dynamically create multiple floating, tabbed windows.
class CMultiPaneFrameWnd : public CPaneFrameWnd
Public Methods
Most of the methods in this class override methods in the CPaneFrameWnd Class class.
If a pane uses the AFX_CBRS_AUTO_ROLLUP style and the user docks that pane to a multi-pane frame window, the user can roll up the window regardless of the style settings of the other docked panes.
The framework automatically creates a CMultiPaneFrameWnd object when the user floats a pane that uses the CBRS_FLOAT_MULTI style.
For information about deriving a class from the CPaneFrameWnd class and creating it dynamically, see CPaneFrameWnd.
The following example demonstrates how to retrieve a pointer to a CMultiPaneFrameWnd object. This code snippet is part of the Set Pane Size sample.
// CDockablePane* pBar
CMultiPaneFrameWnd* pParentMiniFrame =
DYNAMIC_DOWNCAST (CMultiPaneFrameWnd, pBar->GetParentMiniFrame ()) ;
Header: afxMultiPaneFrameWnd.h
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void AddPane(CBasePane* pWnd);
Parameters
[in] pWnd
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual BOOL AddRecentPane(CDockablePane* pBar);
Parameters
[in] pBar
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void AdjustLayout();
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void AdjustPaneFrames();
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void CalcExpectedDockedRect(
CWnd* pWndToDock,
CPoint ptMouse,
CRect& rectResult,
BOOL& bDrawTab,
CDockablePane** ppTargetBar);
Parameters
[in] pWndToDock
[in] ptMouse
[in] rectResult
[in] bDrawTab
[in] ppTargetBar
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual BOOL CanBeAttached() const;
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual BOOL CanBeDockedToPane(const CDockablePane* pDockingBar) const;
Parameters
[in] pDockingBar
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void CheckGripperVisibility();
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void CloseMiniFrame();
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void ConvertToTabbedDocument();
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual BOOL DockFrame(
CPaneFrameWnd* pDockedFrame,
AFX_DOCK_METHOD dockMethod);
Parameters
[in] pDockedFrame
[in] dockMethod
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual BOOL DockPane(CDockablePane* pDockedBar);
Parameters
[in] pDockedBar
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void DockRecentPaneToMainFrame(CDockablePane* pBar);
Parameters
[in] pBar
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual CString GetCaptionText();
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual CWnd* GetFirstVisiblePane() const;
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual CWnd* GetPane() const;
Return Value
Remarks
Returns a reference to the internal container manager object.
CPaneContainerManager& GetPaneContainerManager();
Return Value
A reference to the internal container manager object.
Remarks
This method can be used to access the internal CPaneContainerManager Class object.
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual int GetPaneCount() const;
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual int GetVisiblePaneCount() const;
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual BOOL InsertPane(
CBasePane* pControlBar,
CBasePane* pTarget,
BOOL bAfter);
Parameters
[in] pControlBar
[in] pTarget
[in] bAfter
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual BOOL LoadState(
LPCTSTR lpszProfileName = NULL,
UINT uiID = (UINT) -1);
Parameters
[in] lpszProfileName
[in] uiID
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void OnDockToRecentPos();
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void OnKillRollUpTimer();
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void OnPaneRecalcLayout();
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void OnSetRollUpTimer();
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void OnShowPane(
CDockablePane* pBar,
BOOL bShow);
Parameters
[in] pBar
[in] bShow
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual CBasePane* PaneFromPoint(
CPoint point,
int nSensitivity,
BOOL bCheckVisibility);
Parameters
[in] point
[in] nSensitivity
[in] bCheckVisibility
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void RemoveNonValidPanes();
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void RemovePane(
CBasePane* pBar,
BOOL bDestroy = FALSE,
BOOL bNoDelayedDestroy = TRUE);
Parameters
[in] pBar
[in] bDestroy
[in] bNoDelayedDestroy
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void ReplacePane(
CBasePane* pBarOrg,
CBasePane* pBarReplaceWith);
Parameters
[in] pBarOrg
[in] pBarReplaceWith
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual BOOL SaveState(
LPCTSTR lpszProfileName = NULL,
UINT uiID = (UINT) -1);
Parameters
[in] lpszProfileName
[in] uiID
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void Serialize(CArchive& ar);
Parameters
[in] ar
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void SetDockState(CDockingManager* pDockManager);
Parameters
[in] pDockManager
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
void SetLastFocusedPane(HWND hwnd);
Parameters
[in] hwnd
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual BOOL SetPreDockState(
AFX_PREDOCK_STATE preDockState,
CBasePane* pBarToDock = NULL,
AFX_DOCK_METHOD dockMethod = DM_MOUSE);
Parameters
[in] preDockState
[in] pBarToDock
[in] dockMethod
Return Value
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void StoreRecentDockSiteInfo(CPane* pBar);
Parameters
[in] pBar
Remarks
This topic is included for completeness. For more detail see the source code located in the VC\atlmfc\src\mfc folder of your Visual Studio installation.
virtual void StoreRecentTabRelatedInfo(
CDockablePane* pDockingBar,
CDockablePane* pTabbedBar);
Parameters
[in] pDockingBar
[in] pTabbedBar