PagePaintHook

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
Yes
Import Library
user-defined
Header File
commdlg.h
Unicode
No
Platform Notes
LPPAGEPAINTHOOK

A PagePaintHook hook procedure is an application-defined or library-defined callback procedure that is used with the Page Setup dialog box. The hook procedure receives messages that allow you to customize drawing of the sample page in the Page Setup dialog box.

UINT APIENTRY PagePaintHook(

HWND hdlg,	// handle to the dialog box window
UINT uiMsg,	// message identifier
WPARAM wParam,	// message parameter
LPARAM lParam	// message parameter
);

Parameters
hdlg

Handle to the Page Setup dialog box window.

uiMsg
Identifies the message being received.

wParam

Specifies additional information about the message. The exact meaning depends on the value of the uiMsg parameter.

lParam
Specifies additional information about the message. The exact meaning depends on the value of the uiMsg parameter.

Return Values
If the hook procedure returns TRUE for any of the first three messages of a drawing sequence (WM_PSD_PAGESETUPDLG, WM_PSD_FULLPAGERECT, or WM_PSD_MINMARGINRECT), the dialog box sends no more messages and does not draw in the sample page until the next time the system needs to redraw the sample page. If the hook procedure returns FALSE for all three messages, the dialog box sends the remaining messages of the drawing sequence.

If the hook procedure returns TRUE for any of the remaining messages in a drawing sequence, the dialog box does not draw the corresponding portion of the sample page. If the hook procedure returns FALSE for any of these messages, the dialog box draws that portion of the sample page.

Remarks
The Page Setup dialog box includes an image of a sample page that shows how the user's selections affect the appearance of the printed output. The image consists of a rectangle that represents the selected paper or envelope type, with a dotted-line rectangle representing the current margins, and partial (greek text) characters to show how text looks on the printed page. When you use the PageSetupDlg function to create a Page Setup dialog box, you can provide a PagePaintHook hook procedure to customize the appearance of the sample page.

To enable the hook procedure, use the PAGESETUPDLG structure that you passed to the dialog creation function. Specify the pointer to the hook procedure in the lpfnPagePaintHook member and specify the PSD_ENABLEPAGEPAINTHOOK flag in the Flags member.

Whenever the dialog box is about to draw the contents of the sample page, the hook procedure receives the following messages in the order in which they are listed:

Message	Meaning
WM_PSD_PAGESETUPDLG	The dialog box is about to draw the sample page. The hook procedure can use this message to prepare to draw the contents of the sample page.
WM_PSD_FULLPAGERECT	The dialog box is about to draw the sample page. This message specifies the bounding rectangle of the sample page.
WM_PSD_MINMARGINRECT	The dialog box is about to draw the sample page. This message specifies the margin rectangle.
WM_PSD_MARGINRECT	The dialog box is about to draw the margin rectangle.
WM_PSD_GREEKTEXTRECT	The dialog box is about to draw the greek text inside the margin rectangle.
WM_PSD_ENVSTAMPRECT	The dialog box is about to draw in the envelope-stamp rectangle of an envelope sample page. This message is sent for envelopes only.
WM_PSD_YAFULLPAGERECT	The dialog box is about to draw the return address portion of an envelope sample page. This message is sent for envelopes and other paper sizes.

PagePaintHook is a placeholder for the application-defined or library-defined function name. The LPPAGEPAINTHOOK type is a pointer to a PagePaintHook hook procedure.