DispatcherFrame Class

Definition

Namespace:

System.Windows.Threading

Assembly:

WindowsBase.dll

Represents an execution loop in the Dispatcher.

C#

public class DispatcherFrame : System.Windows.Threading.DispatcherObject

Inheritance

Object

DispatcherObject

DispatcherFrame

Examples

The following example shows how to use a DispatcherFrame to achieve similar results as the Windows Forms DoEvents method.

C#

public void DoEvents()
{
    DispatcherFrame frame = new DispatcherFrame();
    Dispatcher.CurrentDispatcher.BeginInvoke(DispatcherPriority.Background,
        new DispatcherOperationCallback(ExitFrame), frame);
    Dispatcher.PushFrame(frame);
}

public object ExitFrame(object f)
{
    ((DispatcherFrame)f).Continue = false;
   
    return null;
}

Remarks

DispatcherFrame objects typically fall into two categories:

• Long running, general purpose frames that exit only when instructed to. These frames should exit when they are requested.

• Short running, very specific frames that exit when an important criteria is met. These frames may consider not to exit when they are requested in favor of waiting for their exit criteria to be met. These frames should have a time-out associated with them.

XAML Text Usage

You cannot use this managed class in XAML.

Constructors

DispatcherFrame()	Initializes a new instance of the DispatcherFrame class.
DispatcherFrame(Boolean)	Initializes a new instance of the DispatcherFrame class, by using the specified exit request flag.

Properties

Continue	Gets or sets a value that indicates whether this DispatcherFrame should continue.
Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject)

Methods

CheckAccess()	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)
VerifyAccess()	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)

Applies to

See also

• PushFrame(DispatcherFrame)