Class OperationFeedbackListener

This class listens to a list of IOperationFeedbackProvider and fires a Progress event if the operation takes longer than a specified Delay.

Inheritance
System.Object
NonFinalizeDisposable
OperationFeedbackListener
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.Windows.ComponentModel
Assembly: Syncfusion.GridCommon.WPF.dll
Syntax
public class OperationFeedbackListener : NonFinalizeDisposable, IDisposable
Remarks

Derive from this class if you want to add support for displaying status messages in your status bar.

note

OperationFeedbackListener operates on the same thread where the long operation takes place. See the class how to give feedback about the operation on a different thread and allow the user to cancel the operation by pressing the Cancel button in a dialog.

Constructors

OperationFeedbackListener()

Declaration
public OperationFeedbackListener()

Properties

Delay

Gets / sets the delay in milliseconds before Progress events about an operation should be raised.

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

Methods

add_Progress(OperationFeedbackEventHandler)

Declaration
public void add_Progress(OperationFeedbackEventHandler value)
Parameters
Type Name Description
OperationFeedbackEventHandler value

AddProvider(IOperationFeedbackProvider)

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

Declaration
public void AddProvider(IOperationFeedbackProvider provider)
Parameters
Type Name Description
IOperationFeedbackProvider provider

An object that implements the IOperationFeedbackProvider interface.

Dispose(Boolean)

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

OnProgress(OperationFeedbackEventArgs)

Raises the Progress event.

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

An OperationFeedbackEventArgs that contains the event data.

remove_Progress(OperationFeedbackEventHandler)

Declaration
public void remove_Progress(OperationFeedbackEventHandler value)
Parameters
Type Name Description
OperationFeedbackEventHandler value

RemoveProvider(IOperationFeedbackProvider)

Removes an IOperationFeedbackProvider from the list of feedback providers.

Declaration
public void RemoveProvider(IOperationFeedbackProvider provider)
Parameters
Type Name Description
IOperationFeedbackProvider provider

An object that implements the IOperationFeedbackProvider interface.

Events

Progress

Occurs to indicate the progress of an ongoing operation.

Declaration
public event OperationFeedbackEventHandler Progress
Event Type
Type
OperationFeedbackEventHandler

Implements

System.IDisposable