SftPrintPreview/DLL 2.0 - Print Preview Control for C/C++

NM_SFTPRINTPREVIEW_HELP_CODE Notification Code

The NM_SFTPRINTPREVIEW_HELP_CODE notification code is sent when the user requests online help.

NM_SFTPRINTPREVIEW_HELP* pNtfy = (NM_SFTPRINTPREVIEW_HELP*) lParam;

Parameters (WM_NOTIFY Message)

wParam

Contains the Print Preview control's control identifier.

lParam

Pointer to an NM_SFTPRINTPREVIEW_HELP structure that contains information specific to this notification. The structure also contains a standard NMHDR structure, which has additional information about the control sending this notification.

Return Value

The return value is ignored.

Comments

The NM_SFTPRINTPREVIEW_HELP_CODE notification code is sent when the user requests online help. The user can request online help by clicking on the Help button of the Page Setup dialog or by clicking on the Help button of the built-in tool bar.

This notification is not sent when the user hits F1 (or similar keys) as these are normally handled by the application, typically using a keyboard accelerator table (see Windows LoadAccelerators, TranslateAccelerator, etc.).

The parent window of the Print Preview control receives the NM_SFTPRINTPREVIEW_HELP_CODE notification code through the WM_NOTIFY message.

Example

C

LRESULT CALLBACK MainWindowProc(HWND hwndMain, UINT uMsg, WPARAM wParam, LPARAM lParam)
{
    switch (uMsg) {
        case WM_NOTIFY: {
            int id = (int) wParam;
            LPNMHDR pnmh = (LPNMHDR) lParam;
            switch (id) {
                case IDC_PREVIEW:
                switch (pnmh->code) {
                    case NM_SFTPRINTPREVIEW_HELP_CODE: { // help requested
                        NM_SFTPRINTPREVIEW_HELP* pNtfy = (NM_SFTPRINTPREVIEW_HELP*) lParam;
                        MessageBox(hwndMain, TEXT("Sorry, this sample application doesn't include online help."),
                        TEXT("SftPrintPreview/DLL"), MB_OK);
                        break;
                    }
                }
                break;
            }
            break;
        }
    }
    return DefWindowProc(hwndMain, uMsg, wParam, lParam);
}

C++

BEGIN_MESSAGE_MAP(CPreviewPagePrinting, CSftPrintPreview_View)
    ON_NM_SFTPRINTPREVIEW_HELP_CODE_REFLECT(OnNotifyHelpReflect)
END_MESSAGE_MAP()

afx_msg void CPreviewPagePrinting::OnNotifyHelpReflect(NMHDR * pNotifyStruct, LRESULT* lResult)
{
    MessageBox(_T("Sorry, this sample application doesn't include online help."),
    _T("SftPrintPreview/DLL"), MB_OK);
    *lResult = 0;
}

See Also C/C++ API | C++ Classes | Notifications