Click or drag to resize

OmrPageProgressEventArgs Class

This class is passed to the user when OmrEngine's PageProgress event is fired.
Inheritance Hierarchy
SystemObject
  SystemEventArgs
    System.ComponentModelCancelEventArgs
      Atalasoft.FormsProcessing.OmrOmrPageProgressEventArgs

Namespace:  Atalasoft.FormsProcessing.Omr
Assembly:  Atalasoft.dotImage.FormsProcessing (in Atalasoft.dotImage.FormsProcessing.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
Syntax
public class OmrPageProgressEventArgs : CancelEventArgs

The OmrPageProgressEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodOmrPageProgressEventArgs
Creates a new OmrDocumentProgressEventArgs instance with the following Stage, CurrentPage and TotalPages values.
Top
Properties
  NameDescription
Public propertyCancel
Gets or sets a value indicating whether the event should be canceled.
(Inherited from CancelEventArgs.)
Public propertyCurrentPage
The current page being processed, counting from 0.
Public propertyProgress
A number between 0 and 100 which represents the progress done in document processing. This will be null if the ImageSource provided does not report the total number of pages.
Public propertyProgressIsValid
True if the progress reported by this event is valid. False if it is not.
Public propertyStage
The current stage in OMR page-wide processing.
Public propertyTotalPages
The total number of pages being processed. This will be null if the ImageSource provided does not report the total number of pages.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also