1<?xml version="1.0" encoding="utf-8"?> 2<Type Name="CommandEventArgs" FullName="System.Web.UI.WebControls.CommandEventArgs"> 3 <TypeSignature Language="C#" Maintainer="auto" Value="public class CommandEventArgs : EventArgs" /> 4 <AssemblyInfo> 5 <AssemblyName>System.Web</AssemblyName> 6 <AssemblyPublicKey> 7 </AssemblyPublicKey> 8 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 9 <AssemblyVersion>2.0.0.0</AssemblyVersion> 10 </AssemblyInfo> 11 <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> 12 <Base> 13 <BaseTypeName>System.EventArgs</BaseTypeName> 14 </Base> 15 <Interfaces /> 16 <Docs> 17 <remarks> 18 <attribution license="cc4" from="Microsoft" modified="false" /> 19 <para>The Command event is raised when a <see cref="T:System.Web.UI.WebControls.Button" /> or <see cref="T:System.Web.UI.WebControls.ImageButton" /> control is clicked.</para> 20 <para>The <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> object contains data about the Command event that can be accessed in the event handler. Using the properties available in the <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> class, you can determine the name of the command to perform, such as Sort, in addition to an optional argument that supplements the command, such as Ascending.</para> 21 <para>For a list of initial property values for an instance of <see cref="T:System.Web.UI.WebControls.CommandEventArgs" />, see the <see cref="Overload:System.Web.UI.WebControls.CommandEventArgs.#ctor" /> constructor.</para> 22 <para>For more information about handling events, see <format type="text/html"><a href="01E4F1BC-E55E-413F-98C7-6588493E5F67">[<topic://cpconEventsOverview>]</a></format>.</para> 23 </remarks> 24 <summary> 25 <attribution license="cc4" from="Microsoft" modified="false" /> 26 <para>Provides data for the Command event.</para> 27 </summary> 28 </Docs> 29 <Members> 30 <Member MemberName=".ctor"> 31 <MemberSignature Language="C#" Value="public CommandEventArgs (System.Web.UI.WebControls.CommandEventArgs e);" /> 32 <MemberType>Constructor</MemberType> 33 <ReturnValue /> 34 <Parameters> 35 <Parameter Name="e" Type="System.Web.UI.WebControls.CommandEventArgs" /> 36 </Parameters> 37 <Docs> 38 <remarks> 39 <attribution license="cc4" from="Microsoft" modified="false" /> 40 <para>Use this constructor to create and initialize a new instance of the <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> class using the specified <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> object.</para> 41 <para>When an instance of <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> is created by a call to this constructor, the following properties are initialized to the specified values.</para> 42 <list type="table"> 43 <listheader> 44 <item> 45 <term> 46 <para>Property </para> 47 </term> 48 <description> 49 <para>Initial Value </para> 50 </description> 51 </item> 52 </listheader> 53 <item> 54 <term> 55 <para>CommandName </para> 56 </term> 57 <description> 58 <para>The <paramref name="e.CommandName" /> parameter. </para> 59 </description> 60 </item> 61 <item> 62 <term> 63 <para>CommandArgument </para> 64 </term> 65 <description> 66 <para>The <paramref name="e.CommandArgument" /> parameter. </para> 67 </description> 68 </item> 69 </list> 70 </remarks> 71 <summary> 72 <attribution license="cc4" from="Microsoft" modified="false" /> 73 <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> class with another <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> object.</para> 74 </summary> 75 <param name="e"> 76 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> that contains the event data. </param> 77 </Docs> 78 <AssemblyInfo> 79 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 80 <AssemblyVersion>2.0.0.0</AssemblyVersion> 81 </AssemblyInfo> 82 </Member> 83 <Member MemberName=".ctor"> 84 <MemberSignature Language="C#" Value="public CommandEventArgs (string name, object argument);" /> 85 <MemberType>Constructor</MemberType> 86 <ReturnValue /> 87 <Parameters> 88 <Parameter Name="name" Type="System.String" /> 89 <Parameter Name="argument" Type="System.Object" /> 90 </Parameters> 91 <Docs> 92 <param name="name">To be added.</param> 93 <remarks> 94 <attribution license="cc4" from="Microsoft" modified="false" /> 95 <para>Use this constructor to create and initialize a new instance of the <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> class using the specified command name and argument.</para> 96 <para>When an instance of <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> is created by a call to this constructor, the following properties are initialized to the specified values.</para> 97 <list type="table"> 98 <listheader> 99 <item> 100 <term> 101 <para>Property </para> 102 </term> 103 <description> 104 <para>Initial Value </para> 105 </description> 106 </item> 107 </listheader> 108 <item> 109 <term> 110 <para>CommandName </para> 111 </term> 112 <description> 113 <para>The value of the <paramref name="commandName" /> parameter. </para> 114 </description> 115 </item> 116 <item> 117 <term> 118 <para>CommandArgument </para> 119 </term> 120 <description> 121 <para>The value of the <paramref name="argument" /> parameter. </para> 122 </description> 123 </item> 124 </list> 125 </remarks> 126 <summary> 127 <attribution license="cc4" from="Microsoft" modified="false" /> 128 <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> class with the specified command name and argument.</para> 129 </summary> 130 <param name="argument"> 131 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Object" /> that contains the arguments for the command. </param> 132 </Docs> 133 <AssemblyInfo> 134 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 135 <AssemblyVersion>2.0.0.0</AssemblyVersion> 136 </AssemblyInfo> 137 </Member> 138 <Member MemberName="CommandArgument"> 139 <MemberSignature Language="C#" Value="public object CommandArgument { get; }" /> 140 <MemberType>Property</MemberType> 141 <ReturnValue> 142 <ReturnType>System.Object</ReturnType> 143 </ReturnValue> 144 <Docs> 145 <value>To be added: an object of type 'object'</value> 146 <remarks> 147 <attribution license="cc4" from="Microsoft" modified="false" /> 148 <para>The <see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandArgument" /> can contain any string set by the programmer. The <see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandArgument" /> property complements the <see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandName" /> property by allowing you to provide any additional information for the command. For example, you can set the <see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandName" /> property to Sort and set the <see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandArgument" /> property to Ascending to specify a command to sort in ascending order.</para> 149 </remarks> 150 <summary> 151 <attribution license="cc4" from="Microsoft" modified="false" /> 152 <para>Gets the argument for the command.</para> 153 </summary> 154 </Docs> 155 <AssemblyInfo> 156 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 157 <AssemblyVersion>2.0.0.0</AssemblyVersion> 158 </AssemblyInfo> 159 </Member> 160 <Member MemberName="CommandName"> 161 <MemberSignature Language="C#" Value="public string CommandName { get; }" /> 162 <MemberType>Property</MemberType> 163 <ReturnValue> 164 <ReturnType>System.String</ReturnType> 165 </ReturnValue> 166 <Docs> 167 <value>To be added: an object of type 'string'</value> 168 <remarks> 169 <attribution license="cc4" from="Microsoft" modified="false" /> 170 <para>Use the <see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandName" /> property to determine the command to perform. The <see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandName" /> property can contain any string set by the programmer. The programmer can then identify the command name in code and perform the appropriate tasks.</para> 171 </remarks> 172 <summary> 173 <attribution license="cc4" from="Microsoft" modified="false" /> 174 <para>Gets the name of the command.</para> 175 </summary> 176 </Docs> 177 <AssemblyInfo> 178 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 179 <AssemblyVersion>2.0.0.0</AssemblyVersion> 180 </AssemblyInfo> 181 </Member> 182 </Members> 183</Type>