IsCancelPending Property

Summary

Aborts the load operation.

Syntax

C++

public bool IsCancelPending {get; set;}

Public Property IsCancelPending() As Boolean 
   Get 
   Set

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

Property Value

true to abort the current load operation; otherwise, false. Default value is false.

Remarks

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.

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

Example

For an example, refer to DocumentFactory.LoadFromUriAsync.

Requirements

Target Platforms