CBaseTabbedPane::FloatTab

Floats a pane, but only if the pane currently resides in a detachable tab.

virtual BOOL FloatTab(
    CWnd* pBar,
    int nTabID,
    AFX_DOCK_METHOD dockMethod,
    BOOL bHide = FALSE
);

Parameters

  • [in] [out] pBar
    A pointer to the pane to float.

  • [in] nTabID
    Specifies the zero-based index of the tab to float.

  • [in] dockMethod
    Specifies the method to use to make the pane float. For more information, see the Remarks section.

  • [in] bHide
    TRUE to hide the pane before floating; otherwise, FALSE.

Return Value

TRUE if the pane floated; otherwise, FALSE.

Remarks

Call this method to float a pane that currently resides in a detachable tab.

If you want to detach a pane programmatically, specify DM_SHOW for the dockMethod parameter. If you want to float the pane in the same position where it floated previously, specify DM_DBL_CLICK as the dockMethod parameter.

Requirements

Header: afxBaseTabbedPane.h

See Also

Reference

CBaseTabbedPane Class

Hierarchy Chart