Class OperationFeedbackEventArgs

Holds status information about an ongoing operation.

Inheritance

System.Object

OperationFeedbackEventArgs

Namespace: Syncfusion.ComponentModel

Assembly: Syncfusion.Shared.Base.dll

Syntax

public sealed class OperationFeedbackEventArgs : CancelEventArgs

Constructors

OperationFeedbackEventArgs(OperationMilestone, String, String, Int32, Int32, Boolean, Boolean)

Initializes the event args.

Declaration

public OperationFeedbackEventArgs(OperationMilestone milestone, string name, string description, int percent, int ticks, bool allowCancel, bool allowRollback)

Parameters

Type	Name	Description
OperationMilestone	milestone	The current status of the operation.
System.String	name	The name of the operation.
System.String	description	A textual description for the operation.
System.Int32	percent	The percentage of work the operation completed so far or -1 if the operation is not able to calculate a meaningful percentage value.
System.Int32	ticks	The number of milliseconds that passed since the operation started.
System.Boolean	allowCancel	Indicates whether the operation can be canceled by the user.
System.Boolean	allowRollback	Indicates whether changes made by the operation can be rolled back if the operation is canceled by the user.

Properties

AllowCancel

Indicates whether the operation can be canceled by the user.

Declaration

public bool AllowCancel { get; }

Property Value

Type
System.Boolean

AllowRollback

Indicates whether changes made by the operation can be rolled back if the operation is canceled by the user.

Declaration

public bool AllowRollback { get; }

Property Value

Type
System.Boolean

Description

Returns the textual description for the operation.

Declaration

public string Description { get; }

Property Value

Type
System.String

Milestone

Returns the current status of the operation.

Declaration

public OperationMilestone Milestone { get; }

Property Value

Type
OperationMilestone

Name

Returns the name of the operation.

Declaration

public string Name { get; }

Property Value

Type
System.String

Percent

Returns the percentage of work the operation completed so far; -1 if the operation is not able to calculate a meaningful percentage value.

Declaration

public int Percent { get; }

Property Value

Type
System.Int32

Rollback

Indicates whether the operation should roll back.

Declaration

public bool Rollback { get; set; }

Property Value

Type
System.Boolean

Ticks

Returns the number of milliseconds that passed since the operation started.

Declaration

public int Ticks { get; }

Property Value

Type
System.Int32