Share via


CPagerCtrl::IsButtonDepressed

Indicates whether the specified scroll button of the current pager control is in pressed state.

BOOL IsButtonDepressed(
     int iButton
) const;

Requirements

Header: afxcmn.h

Parameters

Parameter

Description

[in] iButton

Indicates the button for which the state is retrieved. If the pager control style is PGS_HORZ, specify PGB_TOPORLEFT for the left button and PGB_BOTTOMORRIGHT for the right button. If the pager control style is PGS_VERT, specify PGB_TOPORLEFT for the top button and PGB_BOTTOMORRIGHT for the bottom button. For more information, see Pager Control Styles.

Return Value

true if the specified button is in pressed state; otherwise, false.

Remarks

This method sends the PGM_GETBUTTONSTATE message, which is described in the Windows SDK. It then tests whether the state that is returned is PGF_DEPRESSED. For more information, see the Return Value section of the PGM_GETBUTTONSTATE message.

See Also

Reference

CPagerCtrl Class

Hierarchy Chart

PGM_GETBUTTONSTATE

CPagerCtrl::GetButtonState

Other Resources

CPagerCtrl Members