PrintMsgBox, ScriptPrintMsgBox Events

Applies To

fpSpread control

Description

Occurs before the provided print abort dialog box is displayed and after the print job is complete.

Syntax

C++

afx_msg void OnPrintMsgBoxfpSpread(UINT, int, CWnd*, LPVOID);

Visual Basic

Sub fpSpread_PrintMsgBox(ByVal Text As String, ByVal PrintID As Long, ByVal OpenMsgBox As Boolean, Processed As Boolean)

Note: The ScriptPrintMsgBox event uses the same syntax except event parameters that are not passed "ByVal" are declared as variants. For more information on Script events, see Scripting Environment Usage.

Parameter

The following parameters are available:

Parameter	Description
Text	Value of PrintAbortMsg property
PrintID	An ID used to identify the print job
OpenMsgBox	True before provided print abort dialog box is displayed False after print job is complete
Processed	Set to True to supply your own dialog box

Remarks

Use this event to provide a custom print abort dialog box for the user by overriding the provided print abort dialog box. To override the provided dialog box, set the Processed parameter to True. Provide code to display your custom print abort dialog box. When the event occurs after the print job is complete, provide code in the event to remove your custom dialog box.

To provide custom text for the provided print abort dialog box, set the PrintAbortMsg property.

You must provide a text string using the PrintAbortMsg property for this event to occur.

Use the SheetSendingEvent property if you want to return the sheet for which this event occured.

Note: This event will occur if you use the fpSpread control in a scripting environment (for example, Microsoft's Visual InterDev or Internet Explorer) or a non-scripting environment. However, if you want to use the fpSpread control in a scripting environment and you want to change any parameter that is not passed "ByVal", you must set the ScriptEnhanced property to True and use the ScriptPrintMsgBox event. ScriptPrintMsgBox event parameters that are not passed "ByVal" are declared as variants.