Progress Event

Summary

Occurs during the image processing command, to provide status on the progress of the command.

Syntax

Objective-C

C++

Java

public event EventHandler<RasterCommandProgressEventArgs> Progress

Public Virtual Event Progress As EventHandler(Of RasterCommandProgressEventArgs)

typedef void (^LTRasterCommandProgress)(NSInteger percent, BOOL *cancel) 
 
- (BOOL)run:(LTRasterImage *)image  
   progress:(nullable LTRasterCommandProgress)progressHandler  
      error:(NSError **)error

public void addProgressListener(RasterImageProgressListener listener) 
public void removeProgressListener(RasterImageProgressListener listener)

public: 
event EventHandler<RasterCommandProgressEventArgs^>^ Progress

Event Data

The event handler receives an argument of type RasterCommandProgressEventArgs containing data related to this event. The following RasterCommandProgressEventArgs properties provide information specific to this event.

Property	Description
Cancel	Gets or sets a value indicating whether the image processing command should be canceled.

Remarks

The Progress event is fired when the Run method. RasterCommandProgressEventArgs provides data on the current progress of the image processing command. You can use this data to provide visual feedback to the user.

Example

For an example, refer to RasterCommand.

Requirements

Target Platforms