Leadtools.Forms.DocumentWriters Requires Document/Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
Cancel Property
See Also 
Leadtools.Forms.DocumentWriters Namespace > DocumentProgressEventArgs Class : Cancel Property



Gets or sets a value to allow the user to cancel the current operation.

Syntax

Visual Basic (Declaration) 
Public Property Cancel As Boolean
Visual Basic (Usage)Copy Code
Dim instance As DocumentProgressEventArgs
Dim value As Boolean
 
instance.Cancel = value
 
value = instance.Cancel
C# 
public bool Cancel {get; set;}
C++/CLI 
public:
property bool Cancel {
   bool get();
   void set (bool value);
}

Return Value

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

Example

For an example, refer to DocumentWriter.Progress.

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.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Forms.DocumentWriters requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features