Share via


CPane::DockPane

Docks the floating pane to a base pane.

virtual BOOL DockPane(
    CBasePane* pDockBar,
    LPCRECT lpRect,
    AFX_DOCK_METHOD dockMethod
);

Parameters

  • [in] [out] pDockBar
    Specifies the base pane to dock this pane to.

  • [in] lpRect
    Specifies the rectangle on the base pane where this pane is to be docked.

  • [in] dockMethod
    Specifies the docking method to use. Available options are as follows:

    • DM_UNKNOWN

    • DM_MOUSE

    • DM_DBL_CLICK

    • DM_SHOW

    • DM_RECT

    • DM_STANDARD

Return Value

TRUE if the pane was docked successfully; otherwise, FALSE.

Remarks

This method docks the pane to the base pane specified by the pDockBar parameter. You must first enable docking by calling CBasePane::EnableDocking.

Requirements

Header: afxPane.h

See Also

Reference

CPane Class

Hierarchy Chart