TaskConfig Class

KGy SOFT Drawing Libraries Help
Represents asynchronous configuration for Task-returning methods.
Inheritance Hierarchy

SystemObject
  KGySoft.DrawingAsyncConfigBase
    KGySoft.DrawingTaskConfig

Namespace:  KGySoft.Drawing
Assembly:  KGySoft.Drawing (in KGySoft.Drawing.dll) Version: 5.3.0
Syntax

public sealed class TaskConfig : AsyncConfigBase

The TaskConfig type exposes the following members.

Constructors

  NameDescription
Public methodTaskConfig
Initializes a new instance of the TaskConfig class.
Public methodTaskConfig(CancellationToken)
Initializes a new instance of the TaskConfig class.
Top
Properties

  NameDescription
Public propertyCancellationToken
Gets or sets the cancellation token for this operation.
Public propertyMaxDegreeOfParallelism
Gets or sets the maximum degree of parallelism. Zero or less means an automatic configuration based on CPU cores. Set one to execute the operation on a single core. The asynchronous operation will not be blocking even if 1 is set.
Default value: 0.
(Inherited from AsyncConfigBase.)
Public propertyProgress
Gets or sets an IDrawingProgress instance that can handle progress notifications.
Default value: .
(Inherited from AsyncConfigBase.)
Public propertyState
Gets or sets a user-provided object that will be returned by the AsyncState property that can be used to distinguish this particular asynchronous operation from other ones.
Default value: .
(Inherited from AsyncConfigBase.)
Public propertyThrowIfCanceled
Gets or sets whether an OperationCanceledException should be thrown when ending or awaiting a canceled async operation. If the value of this property is , then canceled operations with a return value will return the default value of their return type.
Default value: .
(Inherited from AsyncConfigBase.)
Top
See Also

Reference