DataGridViewSortCompareEventHandler.xml

<Type Name="DataGridViewSortCompareEventHandler" FullName="System.Windows.Forms.DataGridViewSortCompareEventHandler">
  <TypeSignature Language="C#" Value="public delegate void DataGridViewSortCompareEventHandler(object sender, DataGridViewSortCompareEventArgs e);" FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;windowsdesktop-3.0;windowsdesktop-3.1;windowsdesktop-5.0" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed DataGridViewSortCompareEventHandler extends System.MulticastDelegate" />
  <TypeSignature Language="DocId" Value="T:System.Windows.Forms.DataGridViewSortCompareEventHandler" />
  <TypeSignature Language="VB.NET" Value="Public Delegate Sub DataGridViewSortCompareEventHandler(sender As Object, e As DataGridViewSortCompareEventArgs)" />
  <TypeSignature Language="F#" Value="type DataGridViewSortCompareEventHandler = delegate of obj * DataGridViewSortCompareEventArgs -&gt; unit" />
  <TypeSignature Language="C++ CLI" Value="public delegate void DataGridViewSortCompareEventHandler(System::Object ^ sender, DataGridViewSortCompareEventArgs ^ e);" />
  <TypeSignature Language="C#" Value="public delegate void DataGridViewSortCompareEventHandler(object? sender, DataGridViewSortCompareEventArgs e);" FrameworkAlternate="windowsdesktop-6.0;windowsdesktop-7.0;windowsdesktop-8.0;windowsdesktop-9.0" />
  <AssemblyInfo>
    <AssemblyName>System.Windows.Forms</AssemblyName>
    <AssemblyVersion>2.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.Delegate</BaseTypeName>
  </Base>
  <Parameters>
    <Parameter Name="sender" Type="System.Object">
      <Attributes>
        <Attribute FrameworkAlternate="windowsdesktop-8.0;windowsdesktop-9.0">
          <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
    </Parameter>
    <Parameter Name="e" Type="System.Windows.Forms.DataGridViewSortCompareEventArgs" />
  </Parameters>
  <ReturnValue>
    <ReturnType>System.Void</ReturnType>
  </ReturnValue>
  <Docs>
    <param name="sender">The source of the event.</param>
    <param name="e">A <see cref="T:System.Windows.Forms.DataGridViewSortCompareEventArgs" /> that contains the event data.</param>
    <summary>Represents the method that will handle the <see cref="E:System.Windows.Forms.DataGridView.SortCompare" /> event of a <see cref="T:System.Windows.Forms.DataGridView" /> control.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 When you create a <xref:System.Windows.Forms.DataGridViewSortCompareEventHandler> delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see [Handling and Raising Events](/dotnet/standard/events/).  
  
   
  
## Examples  
 The following code example demonstrates the use of <xref:System.Windows.Forms.DataGridView.SortCompare> in a multiple column sort. This example is part of a larger example provided in [How to: Customize Sorting in the Windows Forms DataGridView Control](/dotnet/framework/winforms/controls/how-to-customize-sorting-in-the-windows-forms-datagridview-control).  
  
 :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/DataGridView/SortCompare/form1.cs" id="Snippet10":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.DataGridView.SortCompare/VB/form1.vb" id="Snippet10":::  
  
 ]]></format>
    </remarks>
    <altmember cref="T:System.Windows.Forms.DataGridView" />
    <altmember cref="E:System.Windows.Forms.DataGridView.SortCompare" />
    <altmember cref="T:System.Windows.Forms.DataGridViewSortCompareEventArgs" />
    <related type="Article" href="/dotnet/framework/winforms/controls/how-to-customize-sorting-in-the-windows-forms-datagridview-control">How to: Customize Sorting in the Windows Forms DataGridView Control</related>
  </Docs>
</Type>