CPane::FloatPane

Floats the pane.

virtual BOOL FloatPane(
    CRect rectFloat,
    AFX_DOCK_METHOD dockMethod = DM_UNKNOWN,
    bool bShow = true
);

Parameters

  • [in] rectFloat
    Specifies the location, in screen coordinates, to position the pane when floated.

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

    • DM_UNKNOWN

    • DM_MOUSE

    • DM_DBL_CLICK

    • DM_SHOW

    • DM_RECT

    • DM_STANDARD

  • [in] bShow
    TRUE to show the pane when floated; otherwise, FALSE.

Return Value

TRUE if the pane was floated successfully or if the pane cannot float because CBasePane::CanFloat returns FALSE; otherwise, FALSE.

Remarks

Call this method to float the pane at the position specified by the rectFloat parameter. This method automatically creates a parent mini-frame window for the pane.

Requirements

Header: afxPane.h

See Also

Reference

CPane Class

Hierarchy Chart

CPane::CreateDefaultMiniframe

CPaneFrameWnd Class

CMultiPaneFrameWnd Class