CBaseTabbedPane::SetAutoHideMode

Sets the auto-hide mode for detachable panes in the tabbed pane.

virtual CMFCAutoHideToolBar* SetAutoHideMode(
   BOOL bMode,
   DWORD dwAlignment,
   CMFCAutoHideToolBar* pCurrAutoHideBar = NULL,
   BOOL bUseTimer = TRUE
);

Parameters

• [in] bMode
  TRUE to enable auto-hide mode; FALSE to enable regular docking mode.

• [in] dwAlignment
  Specifies the alignment of the auto-hide pane that is to be created. For a list of possible values, see CPane::MoveByAlignment.

• [in] [out] pCurrAutoHideBar
  A pointer to the current auto-hide toolbar. Can be NULL.

• [in] bUseTimer
  Specifies whether to use the auto-hide effect when the user switches the pane to auto-hide mode, or to hide the pane immediately.

Return Value

A pointer to the auto-hide toolbar that is created when switching to auto-hide mode, or NULL if no toolbar is created.

Remarks

The framework calls this method when a user chooses the pin button to switch the tabbed pane to auto-hide mode or to regular docking mode.

Auto-hide mode is set for each detachable pane in the tabbed pane. Panes that are non-detachable are ignored. For more information, see CMFCBaseTabCtrl::EnableTabDetach.

Call this method to switch a tabbed pane to auto-hide mode programmatically. The pane must be docked to the main frame window (CDockablePane::GetDefaultPaneDivider must return a valid pointer to the CPaneDivider).

Requirements

Header: afxbasetabbedpane.h

See Also

Reference

CBaseTabbedPane Class

Hierarchy Chart