IsCancelPending Property

public bool IsCancelPending {get; set;}

'Declaration
 

Public Property IsCancelPending As Boolean

'Usage
 

Dim instance As LoadAsyncProgressEventArgs
Dim value As Boolean
 
instance.IsCancelPending = value
 
value = instance.IsCancelPending

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

Property Value

Progress can be used to show a progress bar indicator for the user while the factory is loading a document. In this scenario, it is sometimes preferable to allow the user to abort the load operation (for example, through a "Cancel" button in the UI). Set IsCancelPending to true to gracefully abort load thread and cancel the load operation.

When the operation is aborted, the value of Cancelled of the LoadDocumentAsyncOptions.Completed event data will be set to true and the value of Document will be null.

For an example, refer to DocumentFactory.LoadFromUriAsync.

Target Platforms

Reference

LoadAsyncProgressEventArgs Class
LoadAsyncProgressEventArgs Members