DispatcherPriority.xml

<Type Name="DispatcherPriority" FullName="System.Windows.Threading.DispatcherPriority">
  <TypeSignature Language="C#" Value="public enum DispatcherPriority" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed DispatcherPriority extends System.Enum" />
  <TypeSignature Language="DocId" Value="T:System.Windows.Threading.DispatcherPriority" />
  <TypeSignature Language="VB.NET" Value="Public Enum DispatcherPriority" />
  <TypeSignature Language="F#" Value="type DispatcherPriority = " />
  <TypeSignature Language="C++ CLI" Value="public enum class DispatcherPriority" />
  <AssemblyInfo>
    <AssemblyName>WindowsBase</AssemblyName>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Docs>
    <summary>Describes the priorities at which operations can be invoked by way of the <see cref="T:System.Windows.Threading.Dispatcher" />.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 There is no specific system state or "idleness" corresponding to `ApplicationIdle` and `ContextIdle` in the current version of WPF. Both are still valid priorities; an operation with a priority of `ContextIdle` has a higher priority than an operation with a priority of `SystemIdle`.  
  
 The <xref:System.Windows.Threading.Dispatcher> does not throttle the execution of an operation if it exceeds a certain percentage of the CPU. One way to throttle a process is to use a timer.  
  
 If an operation is posted using <xref:System.Windows.Threading.Dispatcher.Invoke%2A?displayProperty=nameWithType> on its own <xref:System.Windows.Threading.Dispatcher> at a priority of `Send`, the operation bypasses the queue and is immediately executed.  
  
## Examples  
 The following example calls the <xref:System.Windows.Threading.Dispatcher.BeginInvoke%2A?displayProperty=nameWithType> method and passes it a delegate with one argument. The priority is set to `Normal`.
  
 :::code language="csharp" source="~/snippets/csharp/System.Windows.Threading/Dispatcher/BeginInvoke/Window1.xaml.cs" id="Snippetthreadingweatherdispatcheronearge":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/ThreadingWeatherForecast/visualbasic/window1.xaml.vb" id="Snippetthreadingweatherdispatcheronearge":::  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="ApplicationIdle">
      <MemberSignature Language="C#" Value="ApplicationIdle" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Threading.DispatcherPriority ApplicationIdle = int32(2)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Threading.DispatcherPriority.ApplicationIdle" />
      <MemberSignature Language="VB.NET" Value="ApplicationIdle" />
      <MemberSignature Language="F#" Value="ApplicationIdle = 2" Usage="System.Windows.Threading.DispatcherPriority.ApplicationIdle" />
      <MemberSignature Language="C++ CLI" Value="ApplicationIdle" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>WindowsBase</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Threading.DispatcherPriority</ReturnType>
      </ReturnValue>
      <MemberValue>2</MemberValue>
      <Docs>
        <summary>The enumeration value is 2. Operations are processed when the application is idle.</summary>
      </Docs>
    </Member>
    <Member MemberName="Background">
      <MemberSignature Language="C#" Value="Background" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Threading.DispatcherPriority Background = int32(4)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Threading.DispatcherPriority.Background" />
      <MemberSignature Language="VB.NET" Value="Background" />
      <MemberSignature Language="F#" Value="Background = 4" Usage="System.Windows.Threading.DispatcherPriority.Background" />
      <MemberSignature Language="C++ CLI" Value="Background" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>WindowsBase</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Threading.DispatcherPriority</ReturnType>
      </ReturnValue>
      <MemberValue>4</MemberValue>
      <Docs>
        <summary>The enumeration value is 4. Operations are processed after all other non-idle operations are completed.</summary>
      </Docs>
    </Member>
    <Member MemberName="ContextIdle">
      <MemberSignature Language="C#" Value="ContextIdle" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Threading.DispatcherPriority ContextIdle = int32(3)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Threading.DispatcherPriority.ContextIdle" />
      <MemberSignature Language="VB.NET" Value="ContextIdle" />
      <MemberSignature Language="F#" Value="ContextIdle = 3" Usage="System.Windows.Threading.DispatcherPriority.ContextIdle" />
      <MemberSignature Language="C++ CLI" Value="ContextIdle" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>WindowsBase</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Threading.DispatcherPriority</ReturnType>
      </ReturnValue>
      <MemberValue>3</MemberValue>
      <Docs>
        <summary>The enumeration value is 3. Operations are processed after background operations have completed.</summary>
      </Docs>
    </Member>
    <Member MemberName="DataBind">
      <MemberSignature Language="C#" Value="DataBind" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Threading.DispatcherPriority DataBind = int32(8)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Threading.DispatcherPriority.DataBind" />
      <MemberSignature Language="VB.NET" Value="DataBind" />
      <MemberSignature Language="F#" Value="DataBind = 8" Usage="System.Windows.Threading.DispatcherPriority.DataBind" />
      <MemberSignature Language="C++ CLI" Value="DataBind" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>WindowsBase</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Threading.DispatcherPriority</ReturnType>
      </ReturnValue>
      <MemberValue>8</MemberValue>
      <Docs>
        <summary>The enumeration value is 8. Operations are processed at the same priority as data binding.</summary>
      </Docs>
    </Member>
    <Member MemberName="Inactive">
      <MemberSignature Language="C#" Value="Inactive" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Threading.DispatcherPriority Inactive = int32(0)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Threading.DispatcherPriority.Inactive" />
      <MemberSignature Language="VB.NET" Value="Inactive" />
      <MemberSignature Language="F#" Value="Inactive = 0" Usage="System.Windows.Threading.DispatcherPriority.Inactive" />
      <MemberSignature Language="C++ CLI" Value="Inactive" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>WindowsBase</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Threading.DispatcherPriority</ReturnType>
      </ReturnValue>
      <MemberValue>0</MemberValue>
      <Docs>
        <summary>The enumeration value is 0. Operations are not processed.</summary>
      </Docs>
    </Member>
    <Member MemberName="Input">
      <MemberSignature Language="C#" Value="Input" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Threading.DispatcherPriority Input = int32(5)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Threading.DispatcherPriority.Input" />
      <MemberSignature Language="VB.NET" Value="Input" />
      <MemberSignature Language="F#" Value="Input = 5" Usage="System.Windows.Threading.DispatcherPriority.Input" />
      <MemberSignature Language="C++ CLI" Value="Input" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>WindowsBase</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Threading.DispatcherPriority</ReturnType>
      </ReturnValue>
      <MemberValue>5</MemberValue>
      <Docs>
        <summary>The enumeration value is 5. Operations are processed at the same priority as input.</summary>
      </Docs>
    </Member>
    <Member MemberName="Invalid">
      <MemberSignature Language="C#" Value="Invalid" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Threading.DispatcherPriority Invalid = int32(-1)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Threading.DispatcherPriority.Invalid" />
      <MemberSignature Language="VB.NET" Value="Invalid" />
      <MemberSignature Language="F#" Value="Invalid = -1" Usage="System.Windows.Threading.DispatcherPriority.Invalid" />
      <MemberSignature Language="C++ CLI" Value="Invalid" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>WindowsBase</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Threading.DispatcherPriority</ReturnType>
      </ReturnValue>
      <MemberValue>-1</MemberValue>
      <Docs>
        <summary>The enumeration value is -1. This is an invalid priority.</summary>
      </Docs>
    </Member>
    <Member MemberName="Loaded">
      <MemberSignature Language="C#" Value="Loaded" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Threading.DispatcherPriority Loaded = int32(6)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Threading.DispatcherPriority.Loaded" />
      <MemberSignature Language="VB.NET" Value="Loaded" />
      <MemberSignature Language="F#" Value="Loaded = 6" Usage="System.Windows.Threading.DispatcherPriority.Loaded" />
      <MemberSignature Language="C++ CLI" Value="Loaded" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>WindowsBase</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Threading.DispatcherPriority</ReturnType>
      </ReturnValue>
      <MemberValue>6</MemberValue>
      <Docs>
        <summary>The enumeration value is 6. Operations are processed when layout and render has finished but just before items at input priority are serviced. Specifically this is used when raising the Loaded event.</summary>
      </Docs>
    </Member>
    <Member MemberName="Normal">
      <MemberSignature Language="C#" Value="Normal" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Threading.DispatcherPriority Normal = int32(9)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Threading.DispatcherPriority.Normal" />
      <MemberSignature Language="VB.NET" Value="Normal" />
      <MemberSignature Language="F#" Value="Normal = 9" Usage="System.Windows.Threading.DispatcherPriority.Normal" />
      <MemberSignature Language="C++ CLI" Value="Normal" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>WindowsBase</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Threading.DispatcherPriority</ReturnType>
      </ReturnValue>
      <MemberValue>9</MemberValue>
      <Docs>
        <summary>The enumeration value is 9. Operations are processed at normal priority. This is the typical application priority.</summary>
      </Docs>
    </Member>
    <Member MemberName="Render">
      <MemberSignature Language="C#" Value="Render" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Threading.DispatcherPriority Render = int32(7)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Threading.DispatcherPriority.Render" />
      <MemberSignature Language="VB.NET" Value="Render" />
      <MemberSignature Language="F#" Value="Render = 7" Usage="System.Windows.Threading.DispatcherPriority.Render" />
      <MemberSignature Language="C++ CLI" Value="Render" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>WindowsBase</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Threading.DispatcherPriority</ReturnType>
      </ReturnValue>
      <MemberValue>7</MemberValue>
      <Docs>
        <summary>The enumeration value is 7. Operations processed at the same priority as rendering.</summary>
      </Docs>
    </Member>
    <Member MemberName="Send">
      <MemberSignature Language="C#" Value="Send" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Threading.DispatcherPriority Send = int32(10)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Threading.DispatcherPriority.Send" />
      <MemberSignature Language="VB.NET" Value="Send" />
      <MemberSignature Language="F#" Value="Send = 10" Usage="System.Windows.Threading.DispatcherPriority.Send" />
      <MemberSignature Language="C++ CLI" Value="Send" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>WindowsBase</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Threading.DispatcherPriority</ReturnType>
      </ReturnValue>
      <MemberValue>10</MemberValue>
      <Docs>
        <summary>The enumeration value is 10. Operations are processed before other asynchronous operations. This is the highest priority.</summary>
      </Docs>
    </Member>
    <Member MemberName="SystemIdle">
      <MemberSignature Language="C#" Value="SystemIdle" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Threading.DispatcherPriority SystemIdle = int32(1)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Threading.DispatcherPriority.SystemIdle" />
      <MemberSignature Language="VB.NET" Value="SystemIdle" />
      <MemberSignature Language="F#" Value="SystemIdle = 1" Usage="System.Windows.Threading.DispatcherPriority.SystemIdle" />
      <MemberSignature Language="C++ CLI" Value="SystemIdle" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>WindowsBase</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Threading.DispatcherPriority</ReturnType>
      </ReturnValue>
      <MemberValue>1</MemberValue>
      <Docs>
        <summary>The enumeration value is 1. Operations are processed when the system is idle.</summary>
      </Docs>
    </Member>
  </Members>
</Type>