[]
        
(Showing Draft Content)

GrapeCity.Documents.Common.LongOperationEventArgs

LongOperationEventArgs Class

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.

Inheritance
LongOperationEventArgs
Namespace: GrapeCity.Documents.Common
Assembly: DS.Documents.Imaging.dll
Syntax
public class LongOperationEventArgs : EventArgs
Public Class LongOperationEventArgs
    Inherits EventArgs

Constructors

Name Description
LongOperationEventArgs()

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

LongOperationEventArgs(bool)

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

LongOperationEventArgs(float)

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

LongOperationEventArgs(float, bool)

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

Properties

Name Description
CanCancel

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

Cancel

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

Complete

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