Cancel Property

Summary

Allow the user to cancel the current operation.

Syntax

C++

Java

public bool Cancel { get; set; }

Public Property Cancel As Boolean

public boolean getCancel() 
public void setCancel(boolean 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

Reference

DocumentProgressEventArgs Class

DocumentProgressEventArgs Members

DocumentWriter Class

DocumentWriter.Progress

Programming with LEADTOOLS Document Writers

Files to be Included with Your Application

Unlocking Special LEAD Features

Download our FREE evaluation

Help Version 20.0.2020.3.31