DataListCommandEventArgs.xml

<Type Name="DataListCommandEventArgs" FullName="System.Web.UI.WebControls.DataListCommandEventArgs">
  <TypeSignature Language="C#" Value="public sealed class DataListCommandEventArgs : System.Web.UI.WebControls.CommandEventArgs" FrameworkAlternate="netframework-1.1" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit DataListCommandEventArgs extends System.Web.UI.WebControls.CommandEventArgs" FrameworkAlternate="netframework-1.1" />
  <TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.DataListCommandEventArgs" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class DataListCommandEventArgs&#xA;Inherits CommandEventArgs" FrameworkAlternate="netframework-1.1" />
  <TypeSignature Language="F#" Value="type DataListCommandEventArgs = class&#xA;    inherit CommandEventArgs" />
  <TypeSignature Language="C++ CLI" Value="public ref class DataListCommandEventArgs sealed : System::Web::UI::WebControls::CommandEventArgs" FrameworkAlternate="netframework-1.1" />
  <TypeSignature Language="C#" Value="public class DataListCommandEventArgs : System.Web.UI.WebControls.CommandEventArgs" 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" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DataListCommandEventArgs extends System.Web.UI.WebControls.CommandEventArgs" 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" />
  <TypeSignature Language="VB.NET" Value="Public Class DataListCommandEventArgs&#xA;Inherits CommandEventArgs" 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" />
  <TypeSignature Language="C++ CLI" Value="public ref class DataListCommandEventArgs : System::Web::UI::WebControls::CommandEventArgs" 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" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Web.UI.WebControls.CommandEventArgs</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Provides data for the <see cref="E:System.Web.UI.WebControls.DataList.CancelCommand" />, <see cref="E:System.Web.UI.WebControls.DataList.DeleteCommand" />, <see cref="E:System.Web.UI.WebControls.DataList.EditCommand" />, <see cref="E:System.Web.UI.WebControls.DataList.ItemCommand" />, and <see cref="E:System.Web.UI.WebControls.DataList.UpdateCommand" /> events of the <see cref="T:System.Web.UI.WebControls.DataList" /> control. This class cannot be inherited.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Web.UI.WebControls.DataList.CancelCommand> event is raised when the `Cancel` button for an item in the <xref:System.Web.UI.WebControls.DataList> control is clicked.  
  
 The <xref:System.Web.UI.WebControls.DataList.DeleteCommand> event is raised when the `Delete` button for an item in the <xref:System.Web.UI.WebControls.DataList> control is clicked.  
  
 The <xref:System.Web.UI.WebControls.DataList.EditCommand> event is raised when the `Edit` button for an item in the <xref:System.Web.UI.WebControls.DataList> control is clicked.  
  
 The <xref:System.Web.UI.WebControls.DataList.ItemCommand> event is raised when any button for an item in the <xref:System.Web.UI.WebControls.DataList> control is clicked. This allows you to programmatically test for when a specific command button is clicked and take appropriate action. This event is commonly used to handle custom command buttons for the <xref:System.Web.UI.WebControls.DataList> control.  
  
 The <xref:System.Web.UI.WebControls.DataList.UpdateCommand> event is raised when the `Update` button for an item in the <xref:System.Web.UI.WebControls.DataList> control is clicked.  
  
 For a list of initial property values for an instance of <xref:System.Web.UI.WebControls.DataListCommandEventArgs>, see the <xref:System.Web.UI.WebControls.DataListCommandEventArgs.%23ctor%2A> constructor.  
  
 For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).  
  
   
  
## Examples  
 The following example demonstrates how to define event handlers for the <xref:System.Web.UI.WebControls.DataList.EditCommand>, <xref:System.Web.UI.WebControls.DataList.UpdateCommand>, <xref:System.Web.UI.WebControls.DataList.CancelCommand> and <xref:System.Web.UI.WebControls.DataList.DeleteCommand> events of a <xref:System.Web.UI.WebControls.DataList> control. This example specifies the event handlers declaratively, setting the event handler for each command property of the <xref:System.Web.UI.WebControls.DataList> control.  
  
 :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataListEdit/CS/datalisteditcs.aspx" id="Snippet1":::
 :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataListEdit/VB/datalisteditvb.aspx" id="Snippet1":::  
  
 The following example demonstrates how to specify the event handlers and programmatically add them to the events in the `Page_Load` method.  
  
 :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataListEdit2/CS/datalistedit2cs.aspx" id="Snippet1":::
 :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataListEdit2/VB/datalistedit2vb.aspx" id="Snippet1":::  
  
 ]]></format>
    </remarks>
    <altmember cref="T:System.Web.UI.WebControls.DataListCommandEventHandler" />
    <altmember cref="T:System.Web.UI.WebControls.DataList" />
    <altmember cref="E:System.Web.UI.WebControls.DataList.CancelCommand" />
    <altmember cref="E:System.Web.UI.WebControls.DataList.DeleteCommand" />
    <altmember cref="E:System.Web.UI.WebControls.DataList.EditCommand" />
    <altmember cref="E:System.Web.UI.WebControls.DataList.ItemCommand" />
    <altmember cref="E:System.Web.UI.WebControls.DataList.UpdateCommand" />
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public DataListCommandEventArgs (System.Web.UI.WebControls.DataListItem item, object commandSource, System.Web.UI.WebControls.CommandEventArgs originalArgs);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Web.UI.WebControls.DataListItem item, object commandSource, class System.Web.UI.WebControls.CommandEventArgs originalArgs) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.DataListCommandEventArgs.#ctor(System.Web.UI.WebControls.DataListItem,System.Object,System.Web.UI.WebControls.CommandEventArgs)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (item As DataListItem, commandSource As Object, originalArgs As CommandEventArgs)" />
      <MemberSignature Language="F#" Value="new System.Web.UI.WebControls.DataListCommandEventArgs : System.Web.UI.WebControls.DataListItem * obj * System.Web.UI.WebControls.CommandEventArgs -&gt; System.Web.UI.WebControls.DataListCommandEventArgs" Usage="new System.Web.UI.WebControls.DataListCommandEventArgs (item, commandSource, originalArgs)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; DataListCommandEventArgs(System::Web::UI::WebControls::DataListItem ^ item, System::Object ^ commandSource, System::Web::UI::WebControls::CommandEventArgs ^ originalArgs);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters>
        <Parameter Name="item" Type="System.Web.UI.WebControls.DataListItem" />
        <Parameter Name="commandSource" Type="System.Object" />
        <Parameter Name="originalArgs" Type="System.Web.UI.WebControls.CommandEventArgs" />
      </Parameters>
      <Docs>
        <param name="item">The selected item from the <see cref="T:System.Web.UI.WebControls.DataList" />.</param>
        <param name="commandSource">The source of the command.</param>
        <param name="originalArgs">A <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> that contains the original event data.</param>
        <summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.DataListCommandEventArgs" /> class.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 Use this constructor to create and initialize a new instance of the <xref:System.Web.UI.WebControls.DataListCommandEventArgs> class.  
  
 When an instance of <xref:System.Web.UI.WebControls.DataListCommandEventArgs> is created by a call to this constructor, the following properties are initialized to the specified values.  
  
|Property|Initial Value|  
|--------------|-------------------|  
|Item|The value of the `item` parameter.|  
|CommandSource|The value of the `commandSource` parameter.|  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="CommandSource">
      <MemberSignature Language="C#" Value="public object CommandSource { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object CommandSource" />
      <MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.DataListCommandEventArgs.CommandSource" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property CommandSource As Object" />
      <MemberSignature Language="F#" Value="member this.CommandSource : obj" Usage="System.Web.UI.WebControls.DataListCommandEventArgs.CommandSource" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Object ^ CommandSource { System::Object ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the source of the command.</summary>
        <value>The source of the command.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 Use the <xref:System.Web.UI.WebControls.DataListCommandEventArgs.CommandSource%2A> property to determine the command source that raised the event. This property is commonly used to determine which command raises the event. You can then take appropriate action, based on the command.  
  
   
  
## Examples  
 The following example demonstrates how to use the <xref:System.Web.UI.WebControls.DataListCommandEventArgs.CommandSource%2A> property to determine the command selected by the user. It then performs the appropriate action based, on the command.  
  
 :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic DataListCommandEventArgs.Item Example/CS/sourcecs.aspx" id="Snippet1":::
 :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic DataListCommandEventArgs.Item Example/VB/sourcevb.aspx" id="Snippet1":::  
  
 ]]></format>
        </remarks>
        <altmember cref="T:System.Web.UI.WebControls.DataList" />
        <altmember cref="E:System.Web.UI.WebControls.DataList.CancelCommand" />
        <altmember cref="E:System.Web.UI.WebControls.DataList.DeleteCommand" />
        <altmember cref="E:System.Web.UI.WebControls.DataList.EditCommand" />
        <altmember cref="E:System.Web.UI.WebControls.DataList.ItemCommand" />
        <altmember cref="E:System.Web.UI.WebControls.DataList.UpdateCommand" />
      </Docs>
    </Member>
    <Member MemberName="Item">
      <MemberSignature Language="C#" Value="public System.Web.UI.WebControls.DataListItem Item { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Web.UI.WebControls.DataListItem Item" />
      <MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.DataListCommandEventArgs.Item" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Item As DataListItem" />
      <MemberSignature Language="F#" Value="member this.Item : System.Web.UI.WebControls.DataListItem" Usage="System.Web.UI.WebControls.DataListCommandEventArgs.Item" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Web::UI::WebControls::DataListItem ^ Item { System::Web::UI::WebControls::DataListItem ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Web.UI.WebControls.DataListItem</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the item containing the command source in the <see cref="T:System.Web.UI.WebControls.DataList" /> control.</summary>
        <value>A <see cref="T:System.Web.UI.WebControls.DataListItem" /> object that represents the selected item in the <see cref="T:System.Web.UI.WebControls.DataList" /> control.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 Use the <xref:System.Web.UI.WebControls.DataListCommandEventArgs.Item%2A> property to access information about the selected item in the <xref:System.Web.UI.WebControls.DataList> control.  
  
   
  
## Examples  
 The following example demonstrates how to use the <xref:System.Web.UI.WebControls.DataListCommandEventArgs.Item%2A> property to display information about the selected item in the <xref:System.Web.UI.WebControls.DataList> control.  
  
 :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataListEdit/CS/datalisteditcs.aspx" id="Snippet1":::
 :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataListEdit/VB/datalisteditvb.aspx" id="Snippet1":::  
  
 ]]></format>
        </remarks>
        <altmember cref="T:System.Web.UI.WebControls.DataList" />
        <altmember cref="E:System.Web.UI.WebControls.DataList.CancelCommand" />
        <altmember cref="E:System.Web.UI.WebControls.DataList.DeleteCommand" />
        <altmember cref="E:System.Web.UI.WebControls.DataList.EditCommand" />
        <altmember cref="E:System.Web.UI.WebControls.DataList.ItemCommand" />
        <altmember cref="E:System.Web.UI.WebControls.DataList.UpdateCommand" />
      </Docs>
    </Member>
  </Members>
</Type>