Visual Basic (Declaration) | |
---|---|
Public Property Cancel As Boolean |
Visual Basic (Usage) | Copy Code |
---|---|
|
C# | |
---|---|
public bool Cancel {get; set;} |
Return Value
true to cancel the current operation; false to continute the current operation.For an example, refer to DocumentWriter.Progress.
Some of the DocumentWriter operations that use the progress monitor can be lengthy. You can allow the user to cancel the operation by using the DocumentWriter.Progress event to show a progress bar and a cancel button in your application. If the user presses the cancel button, you can set the value of the Cancel property to true to abort the current operation.
Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family