PrintAbort, ScriptPrintAbort Events

Applies To

fpSpread control

Description

Occurs repeatedly when the sheet is printing.

Syntax

C++

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

Visual Basic

Sub fpSpread_PrintAbort(Abort As Boolean)

Note: The ScriptPrintAbort 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 parameter is available:

Parameter	Description
Abort	Status of print job

Remarks

When the user clicks the Cancel button in a print abort dialog box, the fpSpread control passes the Abort parameter as True to inform the application that printing has stopped.

The application can set the Abort parameter at any time to stop printing.

If you want to supply your own dialog box instead of the provided dialog box, you can use the PrintMsgBox event to override the provided dialog box. To provide custom text for the provided 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 ScriptPrintAbort event. ScriptPrintAbort event parameters that are not passed "ByVal" are declared as variants.