←Select platform

Cancel Property

Summary

Allow the user to cancel the current operation.

Syntax

Java

WinRT C#

C++

public bool Cancel {get; set;}

Public Property Cancel As Boolean

public bool Cancel {get; set;}

public boolean getCancel() 
public void setCancel(boolean cancel)

get_Cancel(); 
set_Cancel(value); 
Object.defineProperty('Cancel');

public: 
property bool Cancel { 
   bool get(); 
   void set (    bool ); 
}

Property Value

true to cancel the current operation; false to continue the current operation.

Remarks

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.

Example

For an example, refer to DocumentWriter.Progress.

Requirements

Target Platforms

See Also