GrapeCity.Documents.Common.LongOperationEventArgs

Class LongOperationEventArgs

Namespace

GrapeCity.Documents.Common

Assembly

GcDocs.Imaging.dll

Describes arguments for the event fired periodically by a potentially long operation. Can be used to provide feedback to the user and to allow the user to cancel the operation.

public class LongOperationEventArgs : EventArgs

Inheritance

object

System.EventArgs

LongOperationEventArgs

Inherited Members

System.EventArgs.Empty

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

LongOperationEventArgs()

Creates a new instance of LongOperationEventArgs with default properties (Complete=0, CanCancel=false).

public LongOperationEventArgs()

LongOperationEventArgs(bool)

Creates a new instance of LongOperationEventArgs with the specified CanCancel value and Complete=0.

public LongOperationEventArgs(bool canCancel)

Parameters

canCancel bool

Whether the operation can be canceled.

LongOperationEventArgs(float, bool)

Creates a new instance of LongOperationEventArgs with the specified complete and CanCancel values.

public LongOperationEventArgs(float complete, bool canCancel)

Parameters

complete float

How much is complete (from 0 to 1).

canCancel bool

Whether the operation can be canceled.

LongOperationEventArgs(float)

Creates a new instance of LongOperationEventArgs with the specified complete value and CanCancel=false.

public LongOperationEventArgs(float complete)

Parameters

complete float

How much is complete (from 0 to 1).

Properties

CanCancel

Gets the value indicating whether the event handler can cancel the current long operation by setting the Cancel property to true.

public bool CanCancel { get; }

Property Value

bool

Cancel

Gets or sets a value indicating whether the current long operation should be canceled. (This property is ignored if CanCancel is false.)

public bool Cancel { get; set; }

Property Value

bool

Complete

Gets the approximate completed ratio, from 0 (0% complete) to 1 (100% complete).

public float Complete { get; }

Property Value

float