Applies To
Application Object.
Description
Controls how Microsoft Excel handles CTRL+BREAK (or ESC or COMMAND+PERIOD) user interruptions of the running procedure, as shown in the following table. Read-write.
|
Value |
Meaning |
|
xlDisabled |
Cancel key trapping is completely disabled. |
|
xlInterrupt |
Interrupt the current procedure and allow the user to debug or end the procedure. |
|
xlErrorHandler |
The interrupt is sent to the running procedure as an error, trappable by an error handler setup with an On Error GoTo statement. The trappable error code is 18. |
Remarks
Use this property very carefully. If you use xlDisabled, there is no way to interrupt a runaway loop or other non–self-terminating code. If you use xlErrorHandler but your error handler always returns using the Resume statement, there is also no way to stop runaway code.
The EnableCancelKey property is always reset to xlInterrupt whenever Microsoft Excel returns to the idle state and no code is running. To trap or disable cancellation in your procedure you must explicitly change the EnableCancelKey property every time the procedure is called.
Example
This example shows how the EnableCancelKey property can be used to set up a custom cancellation handler.
On Error GoTo handleCancel
Application.EnableCancelKey = xlErrorHandler
MsgBox "This may take a long time: press ESC to cancel"
For x = 1 To 1000000 ' Do something 1,000,000 times (long!)
' do something here
Next x
handleCancel:
If Err = 18 Then
MsgBox "You cancelled"
End If