Class DelayedStatusDialog

DelayedStatusDialog listens to OperationFeedback events and displays a modeless status dialog if a certain number of ticks have elapsed since the start of the operation.

Inheritance
System.Object
NonFinalizeDisposable
OperationFeedbackListener
DelayedStatusDialog
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.Windows.Forms
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class DelayedStatusDialog : OperationFeedbackListener, IDisposable

Constructors

DelayedStatusDialog()

Overloaded. Initializes a new DelayedStatusDialog instance.

Declaration
public DelayedStatusDialog()

DelayedStatusDialog(IOperationFeedbackProvider)

Initializes a new DelayedStatusDialog instance.

Declaration
public DelayedStatusDialog(IOperationFeedbackProvider provider)
Parameters
Type Name Description
IOperationFeedbackProvider provider

An object that implements the IOperationFeedbackProvider interface.
Remarks

Adds an IOperationFeedbackProvider that this object will listen to and provide user feedback for.

Properties

ShowDialogPercentRule

The progress percentage value to be used for displaying a dialog bar. A dialog bar is displayed when the operation's progress in percentage is less than the specified value at the time progress should be displayed.

Declaration
public int ShowDialogPercentRule { get; set; }
Property Value
Type
System.Int32
Remarks

Typical values are 25 for ShowDialogPercentRule and 75 for ShowWaitCursorPercentRule.

In this example, if the operation takes longer than two seconds and after two seconds only 10% of the operation have completed, a dialog is displayed. If on the other side after two seconds more than 25% have been completed and less than 75%, a wait cursor is displayed. If more than 75% have been completed, no visual feedback at all will be given.

See Also

ShowWaitCursor

Indicates whether wait cursors should be shown.

Declaration
public bool ShowWaitCursor { get; set; }
Property Value
Type
System.Boolean
Remarks

ShowWaitCursorPercentRule is ignored if ShowWaitCursor is False.

ShowWaitCursorPercentRule

The progress percentage value to be used for displaying a wait cursor. A wait cursor is shown when the operation's progress in percentage is less than the specified value at the time progress should be displayed.

Declaration
public int ShowWaitCursorPercentRule { get; set; }
Property Value
Type
System.Int32
Remarks

ShowWaitCursorPercentRule is ignored if ShowWaitCursor is false.

Typical values are 25 for ShowDialogPercentRule and 75 for ShowWaitCursorPercentRule.

In this example, if the operation takes longer than two seconds and after two seconds only 10% of the operation have completed, a dialog is displayed. If on the other side after two seconds more than 25% have been completed and less than 75%, a wait cursor is displayed. If more than 75% have been completed, no visual feedback at all will be given.

See Also

Methods

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides

OnProgress(OperationFeedbackEventArgs)

Overriden. Displays a dialog or wait cursor during progress and closes the dialog when operation is finished.

Declaration
protected override void OnProgress(OperationFeedbackEventArgs e)
Parameters
Type Name Description
OperationFeedbackEventArgs e

An OperationFeedbackEventArgs that contains the event data.
Overrides

Implements

System.IDisposable