Class OcrReadTask

Represents an asynchronous OCR (Optical Character Recognition) read task.

Inheritance
System.Object
OcrReadTask
Namespace: IronOcr
Assembly: IronOcr.dll
Syntax
public class OcrReadTask : Task<OcrResult>

Constructors

OcrReadTask(Func<OcrResult>)

Initializes a new instance of the OcrReadTask class with the specified synchronous OCR function.

Declaration
public OcrReadTask(Func<OcrResult> function)
Parameters
Type Name Description
System.Func<OcrResult> function

The synchronous function that represents the OCR operation.
See Also

OcrReadTask(Func<OcrResult>, CancellationToken)

Initializes a new instance of the OcrReadTask class with the specified synchronous OCR function and cancellation token.

Declaration
public OcrReadTask(Func<OcrResult> function, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Func<OcrResult> function

The synchronous function that represents the OCR operation.
System.Threading.CancellationToken cancellationToken

The cancellation token to observe.
See Also

OcrReadTask(Func<OcrResult>, CancellationToken, TaskCreationOptions)

Initializes a new instance of the OcrReadTask class with the specified synchronous OCR function, cancellation token, and task creation options.

Declaration
public OcrReadTask(Func<OcrResult> function, CancellationToken cancellationToken, TaskCreationOptions creationOptions)
Parameters
Type Name Description
System.Func<OcrResult> function

The synchronous function that represents the OCR operation.
System.Threading.CancellationToken cancellationToken

The cancellation token to observe.
System.Threading.Tasks.TaskCreationOptions creationOptions

The options that control the behavior of the OCR task.
See Also

OcrReadTask(Func<OcrResult>, TaskCreationOptions)

Initializes a new instance of the OcrReadTask class with the specified synchronous OCR function and task creation options.

Declaration
public OcrReadTask(Func<OcrResult> function, TaskCreationOptions creationOptions)
Parameters
Type Name Description
System.Func<OcrResult> function

The synchronous function that represents the OCR operation.
System.Threading.Tasks.TaskCreationOptions creationOptions

The options that control the behavior of the OCR task.
See Also

OcrReadTask(Func<Object, OcrResult>, Object)

Initializes a new instance of the OcrReadTask class with the specified asynchronous OCR function and state object.

Declaration
public OcrReadTask(Func<object, OcrResult> function, object state)
Parameters
Type Name Description
System.Func<System.Object, OcrResult> function

The asynchronous function that represents the OCR operation.
System.Object state

An object representing data to be used by the OCR operation.
See Also

OcrReadTask(Func<Object, OcrResult>, Object, CancellationToken)

Initializes a new instance of the OcrReadTask class with the specified asynchronous OCR function, state object, and cancellation token.

Declaration
public OcrReadTask(Func<object, OcrResult> function, object state, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Func<System.Object, OcrResult> function

The asynchronous function that represents the OCR operation.
System.Object state

An object representing data to be used by the OCR operation.
System.Threading.CancellationToken cancellationToken

The cancellation token to observe.
See Also

OcrReadTask(Func<Object, OcrResult>, Object, CancellationToken, TaskCreationOptions)

Initializes a new instance of the OcrReadTask class with the specified asynchronous OCR function, state object, cancellation token, and task creation options.

Declaration
public OcrReadTask(Func<object, OcrResult> function, object state, CancellationToken cancellationToken, TaskCreationOptions creationOptions)
Parameters
Type Name Description
System.Func<System.Object, OcrResult> function

The asynchronous function that represents the OCR operation.
System.Object state

An object representing data to be used by the OCR operation.
System.Threading.CancellationToken cancellationToken

The cancellation token to observe.
System.Threading.Tasks.TaskCreationOptions creationOptions

The options that control the behavior of the OCR task.
See Also

OcrReadTask(Func<Object, OcrResult>, Object, TaskCreationOptions)

Initializes a new instance of the OcrReadTask class with the specified asynchronous OCR function, state object, and task creation options.

Declaration
public OcrReadTask(Func<object, OcrResult> function, object state, TaskCreationOptions creationOptions)
Parameters
Type Name Description
System.Func<System.Object, OcrResult> function

The asynchronous function that represents the OCR operation.
System.Object state

An object representing data to be used by the OCR operation.
System.Threading.Tasks.TaskCreationOptions creationOptions

The options that control the behavior of the OCR task.
See Also

Methods

Cancel()

Abort the associated Ocr reading

Declaration
public void Cancel()