This section contains information about the API elements used with pager controls.

Overviews

Pager Controls

A pager control is a window container that is used with a window that does not have enough display area to show all of its content.

Macros

Pager_ForwardMouse

Enables or disables mouse forwarding for the pager control. When mouse forwarding is enabled, the pager control forwards WM_MOUSEMOVE messages to the contained window. You can use this macro or send the PGM_FORWARDMOUSE message explicitly.

Pager_GetBkColor

Retrieves the current background color for the pager control. You can use this macro or send the PGM_GETBKCOLOR message explicitly.

Pager_GetBorder

Retrieves the current border size for the pager control. You can use this macro or send the PGM_GETBORDER message explicitly.

Pager_GetButtonSize

Retrieves the current button size for the pager control. You can use this macro or send the PGM_GETBUTTONSIZE message explicitly.

Pager_GetButtonState

Retrieves the state of the specified button in a pager control. You can use this macro or send the PGM_GETBUTTONSTATE message explicitly.

Pager_GetDropTarget

Retrieves a pager control's IDropTarget interface pointer. You can use this macro or send the PGM_GETDROPTARGET message explicitly.

Pager_GetPos

Retrieves the current scroll position of the pager control. You can use this macro or send the PGM_GETPOS message explicitly.

Pager_RecalcSize

Forces the pager control to recalculate the size of the contained window. Using this macro will result in a PGN_CALCSIZE notification being sent. You can use this macro or send the PGM_RECALCSIZE message explicitly.

Pager_SetBkColor

Sets the current background color for the pager control. You can use this macro or send the PGM_SETBKCOLOR message explicitly.

Pager_SetBorder

Sets the current border size for the pager control. You can use this macro or send the PGM_SETBORDER message explicitly.

Pager_SetButtonSize

Sets the current button size for the pager control. You can use this macro or send the PGM_SETBUTTONSIZE message explicitly.

Pager_SetChild

Sets the contained window for the pager control. This macro will not change the parent of the contained window; it only assigns a window handle to the pager control for scrolling. In most cases, the contained window will be a child window. If this is the case, the contained window should be a child of the pager control. You can use this macro or send the PGM_SETCHILD message explicitly.

Pager_SetPos

Sets the scroll position for the pager control. You can use this macro or send the PGM_SETPOS message explicitly.

Pager_SetScrollInfo

Intended for internal use; not recommended for use in applications.

Sets the scrolling parameters of the pager control, including the timeout value, the lines per timeout, and the pixels per line. You can use this macro or send the PGM_SETSETSCROLLINFO message explicitly.

Messages

PGM_FORWARDMOUSE

Enables or disables mouse forwarding for the pager control. When mouse forwarding is enabled, the pager control forwards WM_MOUSEMOVE messages to the contained window. You can send this message explicitly or use the Pager_ForwardMouse macro.

PGM_GETBKCOLOR

Retrieves the current background color for the pager control. You can send this message explicitly or use the Pager_GetBkColor macro.

PGM_GETBORDER

Retrieves the current border size for the pager control. You can send this message explicitly or use the Pager_GetBorder macro.

PGM_GETBUTTONSIZE

Retrieves the current button size for the pager control. You can send this message explicitly or use the Pager_GetButtonSize macro.

PGM_GETBUTTONSTATE

Retrieves the state of the specified button in a pager control. You can send this message explicitly or use the Pager_GetButtonState macro.

PGM_GETDROPTARGET

Retrieves a pager control's IDropTarget interface pointer. You can send this message explicitly or use the Pager_GetDropTarget macro.

PGM_GETPOS

Retrieves the current scroll position of the pager control. You can send this message explicitly or use the Pager_GetPos macro.

PGM_RECALCSIZE

Forces the pager control to recalculate the size of the contained window. Sending this message will result in a PGN_CALCSIZE notification being sent. You can send this message explicitly or use the Pager_RecalcSize macro.

PGM_SETBKCOLOR

Sets the current background color for the pager control. You can send this message explicitly or use the Pager_SetBkColor macro.

PGM_SETBORDER

Sets the current border size for the pager control. You can send this message explicitly or use the Pager_SetBorder macro.

PGM_SETBUTTONSIZE

Sets the current button size for the pager control. You can send this message explicitly or use the Pager_SetButtonSize macro.

PGM_SETCHILD

Sets the contained window for the pager control. This message will not change the parent of the contained window; it only assigns a window handle to the pager control for scrolling. In most cases, the contained window will be a child window. If this is the case, the contained window should be a child of the pager control. You can send this message explicitly or use the Pager_SetChild macro.

PGM_SETPOS

Sets the current scroll position for the pager control. You can send this message explicitly or use the Pager_SetPos macro.

PGM_SETSETSCROLLINFO

Intended for internal use; not recommended for use in applications.

Sets the scrolling parameters of the pager control, including the timeout value, the lines per timeout, and the pixels per line. You can send this message explicitly or by using the Pager_SetScrollInfo macro.

Notifications

NM_RELEASEDCAPTURE (pager)

Notifies a pager control's parent window that the control has released the mouse capture. NM_RELEASEDCAPTURE is sent in the form of a WM_NOTIFY message.

PGN_CALCSIZE

Notification sent by a pager control to obtain the scrollable dimensions of the contained window. These dimensions are used by the pager control to determine the scrollable size of the contained window. This notification is sent in the form of a WM_NOTIFY message.

PGN_HOTITEMCHANGE

Sent by a pager control when the hot (highlighted) item changes.

PGN_SCROLL

Notification sent by a pager control prior to the contained window being scrolled. This notification is sent in the form of a WM_NOTIFY message.

Structures

NMPGCALCSIZE

Contains and receives information that the pager control uses to calculate the scrollable area of the contained window. It is used with the PGN_CALCSIZE notification.

NMPGHOTITEM

Contains information used with the PGN_HOTITEMCHANGE notification.

NMPGSCROLL

Contains and receives information that the pager control uses when scrolling the contained window. It is used with the PGN_SCROLL notification.

Constants

Pager Control Styles

This section lists the window styles used when creating pager controls.