A button that displays or hides a CDockablePane Class that is configured to hide.

[!INCLUDEcpp_fp_under_construction]

class CMFCAutoHideButton : public CObject  

On creation, the CMFCAutoHideButton object is attached to a CDockablePane Class. The CDockablePane object is hidden or displayed as the user interacts with the CMFCAutoHideButton object.

By default, the framework automatically creates a CMFCAutoHideButton when the user turns on auto-hide. The framework can create an element of a custom UI class instead of the CMFCAutoHideButton class. To specify which custom UI class the framework should use, set the static member variable CMFCAutoHideBar::m_pAutoHideButtonRTS equal to the custom UI class. By default, this variable is set to CMFCAutoHideButton.

The following example demonstrates how to construct a CMFCAutoHideButton object and use various methods in the CMFCAutoHideButton class. The example shows how to initialize a CMFCAutoHideButton object by using its Create method, show the associated CDockablePane class, and show the auto-hide button.

[!code-cppNVC_MFC_RibbonApp#32]

CObject

CMFCAutoHideButton

Header: afxautohidebutton.h

void BringToTop();

Creates and initializes an auto-hide button.

virtual BOOL Create(
    CMFCAutoHideBar* pParentBar,  
    CDockablePane* pAutoHideWnd,  
    DWORD dwAlignment);

[in] pParentBar
A pointer to the parent toolbar.

[in] pAutoHideWnd
A pointer to a CDockablePane object. This auto-hide button hides and shows that CDockablePane.

[in] dwAlignment
A value that specifies the alignment of the button with the main frame window.

Nonzero if successful; otherwise 0.

When you create a CMFCAutoHideButton object, you must associate the auto-hide button with a specific CDockablePane. The user can use the auto-hide button to hide and show the associated CDockablePane.

The dwAlignment parameter indicates where the auto-hide button resides in the application. The parameter can be any one of the following values:

• CBRS_ALIGN_LEFT

• CBRS_ALIGN_RIGHT

• CBRS_ALIGN_TOP

• CBRS_ALIGN_BOTTOM

Retrieves the alignment of the auto-hide button.

DWORD GetAlignment() const;  

A DWORD value that contains the current alignment of the auto-hide button.

The alignment of the auto-hide button indicates where the button resides on the application. It can be any one of the following values:

• CBRS_ALIGN_LEFT

• CBRS_ALIGN_RIGHT

• CRBS_ALIGN_TOP

• CBRS_ALIGN_BOTTOM

Returns the CDockablePane object associated with the auto-hide button.

CDockablePane* GetAutoHideWindow() const;  

A pointer to the associated CDockablePane object.

To associate an auto-hide button with a CDockablePane, pass the CDockablePane as a parameter to the CMFCAutoHideButton::Create method.

CMFCAutoHideBar* GetParentToolBar();

CRect GetRect() const;  

Determines the size of the auto-hide button.

CSize GetSize() const;  

A CSize object that contains the button size.

The calculated size includes the size of the border of the auto-hide button.

Returns the size of the text label for the auto-hide button.

virtual CSize GetTextSize() const;  

A CSize object that contains the size of the text for the auto-hide button.

Indicates whether the auto-hide button is active.

BOOL IsActive() const;  

TRUE if the auto-hide button is active; FALSE otherwise.

An auto-hide button is active when the associated CDockablePane Class window is shown.

Determines whether the auto-hide button is horizontal or vertical.

BOOL IsHorizontal() const;  

Nonzero if the button is horizontal; 0 otherwise.

The framework sets the orientation of a CMFCAutoHideButton object when you create it. You can control the orientation by using the dwAlignment parameter in the CMFCAutoHideButton::Create method.

BOOL IsTop() const;  

Indicates whether the auto-hide button is visible.

virtual BOOL IsVisible() const;  

TRUE if the button is visible; FALSE otherwise.

The framework calls this method when it draws the auto-hide button.

virtual void OnDraw(CDC* pDC);

[in] pDC
A pointer to a device context.

If you want to customize the appearance of auto-hide buttons in your application, create a new class derived from CMFCAutoHideButton. In your derived class, override this method.

The framework calls this method when it draws the border of an auto-hide button.

virtual void OnDrawBorder(
    CDC* pDC,  
    CRect rectBounds,  
    CRect rectBorderSize);

[in] pDC
A pointer to a device context.

[in] rectBounds
The bounding rectangle of the auto-hide button.

[in] rectBorderSize
The border thickness for each side of the auto-hide button.

If you want to customize the border of each auto-hide button in your application, create a new class derived from the CMFCAutoHideButton. In your derived class, override this method.

The framework calls this method when it fills the background of an auto-hide button.

virtual void OnFillBackground(
    CDC* pDC,  
    CRect rect);

[in] pDC
A pointer to a device context.

[in] rect
The bounding rectangle of the auto-hide button.

If you want to customize the background for auto-hide buttons in your application, create a new class derived from the CMFCAutoHideButton. In your derived class, override this method.

Shows or hides the associated CDockablePane Class.

void ShowAttachedWindow(BOOL bShow);

[in] bShow
A Boolean that specifies whether this method shows the attached CDockablePane.

Shows or hides the auto-hide button.

virtual void ShowButton(BOOL bShow);

[in] bShow
A Boolean that specifies whether to show the auto-hide button.

void Move(int nOffset);

[in] nOffset

void ReplacePane(CDockablePane* pNewBar);

[in] pNewBar

Disable auto-hide mode.

virtual void UnSetAutoHideMode(CDockablePane* pFirstBarInGroup);

[in] pFirstBarInGroup
A pointer to the first bar in the group.

Highlights the auto hide button.

virtual void HighlightButton(BOOL bHighlight);

bHighlight
Specifies the new auto hide button state. TRUE indicates the button is highlighted, FALSE indicates the button is not highlighted.

Returns the highlight state of the auto hide button.

virtual BOOL IsHighlighted() const;  

Returns TRUE if the auto hide button is highlighted; otherwise FALSE.

Hierarchy Chart
Classes
CMFCAutoHideBar Class
CAutoHideDockSite Class