Progress Event (RasterCommandProcessor)

Occurs during the processing of the image processing commands.

Syntax

C#
Visual Basic
WinRT C#
Java
Objective-C
WinRT JavaScript
C++

public event EventHandler<RasterCommandProcessorProgressEventArgs> Progress

'Declaration

Public Event Progress As EventHandler(Of RasterCommandProcessorProgressEventArgs)

'Usage

Dim instance As RasterCommandProcessor
Dim handler As EventHandler(Of RasterCommandProcessorProgressEventArgs)
 
AddHandler instance.Progress, handler

public event EventHandler<RasterCommandProcessorProgressEventArgs> Progress

add_Progress(function(sender, e))
remove_Progress(function(sender, e))

public:
event EventHandler<RasterCommandProcessorProgressEventArgs^>^ Progress

Event Data

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

Property	Description
Cancel	Determine how to process or cancel the current command.
Command	Gets the IRasterCommand object currently being executed.
CommandNumber	Gets the index of the current RasterCommand in the Commands collection.
Image	Gets the RasterImage object being processed.
ImageNumber	Gets the index of the current RasterImage in the Images collection.
Percent	Gets the percentage completion of the current command.
TotalCommands	Gets the total number of commands to be executed.
TotalImages	Gets the total number of images to be processed.

Remarks

You can use this event to get progress status, or to cancel the process.

Example

For an example, refer to RasterCommandProcessor.

Requirements

Target Platforms

Reference

RasterCommandProcessor Class
RasterCommandProcessor Members