DispatcherQueueTimerExtensions.xml

<Type Name="DispatcherQueueTimerExtensions" FullName="CommunityToolkit.WinUI.UI.DispatcherQueueTimerExtensions">
  <TypeSignature Language="C#" Value="public static class DispatcherQueueTimerExtensions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit DispatcherQueueTimerExtensions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:CommunityToolkit.WinUI.UI.DispatcherQueueTimerExtensions" />
  <TypeSignature Language="VB.NET" Value="Public Module DispatcherQueueTimerExtensions" />
  <TypeSignature Language="F#" Value="type DispatcherQueueTimerExtensions = class" />
  <AssemblyInfo>
    <AssemblyName>CommunityToolkit.WinUI</AssemblyName>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Set of extension methods for using <see cref="T:Microsoft.UI.Dispatching.DispatcherQueueTimer" />.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="Debounce">
      <MemberSignature Language="C#" Value="public static void Debounce (this Microsoft.UI.Dispatching.DispatcherQueueTimer timer, Action action, TimeSpan interval, bool immediate = false);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig void Debounce(class Microsoft.UI.Dispatching.DispatcherQueueTimer timer, class System.Action action, valuetype System.TimeSpan interval, bool immediate) cil managed" />
      <MemberSignature Language="DocId" Value="M:CommunityToolkit.WinUI.UI.DispatcherQueueTimerExtensions.Debounce(Microsoft.UI.Dispatching.DispatcherQueueTimer,System.Action,System.TimeSpan,System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Sub Debounce (timer As DispatcherQueueTimer, action As Action, interval As TimeSpan, Optional immediate As Boolean = false)" />
      <MemberSignature Language="F#" Value="static member Debounce : Microsoft.UI.Dispatching.DispatcherQueueTimer * Action * TimeSpan * bool -&gt; unit" Usage="CommunityToolkit.WinUI.UI.DispatcherQueueTimerExtensions.Debounce (timer, action, interval, immediate)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>CommunityToolkit.WinUI</AssemblyName>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="timer" Type="Microsoft.UI.Dispatching.DispatcherQueueTimer" RefType="this" />
        <Parameter Name="action" Type="System.Action" />
        <Parameter Name="interval" Type="System.TimeSpan" />
        <Parameter Name="immediate" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="timer">Timer instance, only one debounced function can be used per timer.</param>
        <param name="action">Action to execute at the end of the interval.</param>
        <param name="interval">Interval to wait before executing the action.</param>
        <param name="immediate">Determines if the action execute on the leading edge instead of trailing edge.</param>
        <summary>
          <para>Used to debounce (rate-limit) an event.  The action will be postponed and executed after the interval has elapsed.  At the end of the interval, the function will be called with the arguments that were passed most recently to the debounced function.</para>
          <para>Use this method to control the timer instead of calling Start/Interval/Stop manually.</para>
          <para>A scheduled debounce can still be stopped by calling the stop method on the timer instance.</para>
          <para>Each timer can only have one debounced function limited at a time.</para>
        </summary>
        <remarks>To be added.</remarks>
        <example>
          <code>
             private DispatcherQueueTimer _typeTimer = DispatcherQueue.GetForCurrentThread().CreateTimer();
            
             _typeTimer.Debounce(async () =&gt;
                 {
                     // Only executes this code after 0.3 seconds have elapsed since last trigger.
                 }, TimeSpan.FromSeconds(0.3));
             </code>
        </example>
      </Docs>
    </Member>
  </Members>
</Type>