1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="FormViewCommandEventArgs" FullName="System.Web.UI.WebControls.FormViewCommandEventArgs">
<TypeSignature Language="C#" Value="public class FormViewCommandEventArgs : System.Web.UI.WebControls.CommandEventArgs" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.WebControls.CommandEventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="E:System.Web.UI.WebControls.FormView.ItemCommand" /> event is raised when a button within the <see cref="T:System.Web.UI.WebControls.FormView" /> control is clicked. This allows you to provide an event-handling method that performs a custom routine whenever this event occurs.</para>
<para>Buttons within a <see cref="T:System.Web.UI.WebControls.FormView" /> control can also invoke some of the built-in functionality of the control. To perform one of these operations, set the CommandName property of a button to one of the values in the following table.</para>
<list type="table">
<listheader>
<item>
<term>
<para>CommandName value</para>
</term>
<description>
<para>Description</para>
</description>
</item>
</listheader>
<item>
<term>
<para>"Cancel"</para>
</term>
<description>
<para>Cancels an edit or insert operation and returns the <see cref="T:System.Web.UI.WebControls.FormView" /> control to the mode specified by the <see cref="P:System.Web.UI.WebControls.FormView.DefaultMode" /> property. Raises the <see cref="E:System.Web.UI.WebControls.FormView.ModeChanged" /> and <see cref="E:System.Web.UI.WebControls.FormView.ModeChanging" /> events.</para>
</description>
</item>
<item>
<term>
<para>"Delete"</para>
</term>
<description>
<para>Deletes the current record. Raises the <see cref="E:System.Web.UI.WebControls.FormView.ItemDeleted" /> and <see cref="E:System.Web.UI.WebControls.FormView.ItemDeleting" /> events.</para>
</description>
</item>
<item>
<term>
<para>"Edit"</para>
</term>
<description>
<para>Puts the <see cref="T:System.Web.UI.WebControls.FormView" /> control in edit mode. Raises the <see cref="E:System.Web.UI.WebControls.FormView.ModeChanged" /> and <see cref="E:System.Web.UI.WebControls.FormView.ModeChanging" /> events.</para>
</description>
</item>
<item>
<term>
<para>"Insert"</para>
</term>
<description>
<para>Inserts the current record in the data source. Raises the <see cref="E:System.Web.UI.WebControls.FormView.ItemInserted" /> and <see cref="E:System.Web.UI.WebControls.FormView.ItemInserting" /> events.</para>
</description>
</item>
<item>
<term>
<para>"New"</para>
</term>
<description>
<para>Puts the <see cref="T:System.Web.UI.WebControls.FormView" /> control in insert mode. Raises the <see cref="E:System.Web.UI.WebControls.FormView.ModeChanged" /> and <see cref="E:System.Web.UI.WebControls.FormView.ModeChanging" /> events.</para>
</description>
</item>
<item>
<term>
<para>"Page"</para>
</term>
<description>
<para>Performs a paging operation. Set the CommandArgument property of the button to "First", "Last", "Next", "Prev", or a page number to specify the type of paging operation to perform. Raises the <see cref="E:System.Web.UI.WebControls.FormView.PageIndexChanged" /> and <see cref="E:System.Web.UI.WebControls.FormView.PageIndexChanging" /> events.</para>
</description>
</item>
<item>
<term>
<para>"Update"</para>
</term>
<description>
<para>Updates the current record in the data source. Raises the <see cref="E:System.Web.UI.WebControls.FormView.ItemUpdated" /> and <see cref="E:System.Web.UI.WebControls.FormView.ItemUpdating" /> events.</para>
</description>
</item>
</list>
<para>Although the <see cref="E:System.Web.UI.WebControls.FormView.ItemCommand" /> event is raised when a button listed in the previous table is clicked, it is recommended that you use the events listed in the table for the operation.</para>
<para>A <see cref="T:System.Web.UI.WebControls.FormViewCommandEventArgs" /> object is passed to the event-handling method, which allows you to determine the command name and command argument of the button clicked. To determine the command name and command argument, use the <see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandName" /> and <see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandArgument" /> properties, respectively. You can also access the button control that raised the event by using the <see cref="P:System.Web.UI.WebControls.DetailsViewCommandEventArgs.CommandSource" /> property.</para>
<para>For more information about handling events, see <format type="text/html"><a href="01e4f1bc-e55e-413f-98c7-6588493e5f67">Consuming Events</a></format>.</para>
<para>For a list of initial property values for an instance of the <see cref="T:System.Web.UI.WebControls.FormViewCommandEventArgs" /> class, see the <see cref="M:System.Web.UI.WebControls.FormViewCommandEventArgs.#ctor(System.Object,System.Web.UI.WebControls.CommandEventArgs)" /> constructor.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides data for the <see cref="E:System.Web.UI.WebControls.FormView.ItemCommand" /> event.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FormViewCommandEventArgs (object source, System.Web.UI.WebControls.CommandEventArgs arguments);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="source" Type="System.Object" />
<Parameter Name="arguments" Type="System.Web.UI.WebControls.CommandEventArgs" />
</Parameters>
<Docs>
<param name="source">To be added.</param>
<param name="arguments">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this constructor to initialize a new instance of the <see cref="T:System.Web.UI.WebControls.FormViewCommandEventArgs" /> class.</para>
<para>The following table shows the initial property values for an instance of <see cref="T:System.Web.UI.WebControls.FormViewCommandEventArgs" />.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Property </para>
</term>
<description>
<para>Initial value </para>
</description>
</item>
</listheader>
<item>
<term>
<para>
<see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandArgument" /> </para>
</term>
<description>
<para>The value of the <see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandArgument" /> property of the <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> contained in the <paramref name="originalArgs" /> parameter. </para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandName" /> </para>
</term>
<description>
<para>The value of the <see cref="P:System.Web.UI.WebControls.CommandEventArgs.CommandName" /> property of the <see cref="T:System.Web.UI.WebControls.CommandEventArgs" /> contained in the <paramref name="originalArgs" /> parameter. </para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.WebControls.FormViewCommandEventArgs.CommandSource" /> </para>
</term>
<description>
<para>The object contained in the <paramref name="commandSource" /> parameter. </para>
</description>
</item>
</list>
<block subset="none" type="note">
<para>This constructor is used primarily by control developers when raising events.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.FormViewCommandEventArgs" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CommandSource">
<MemberSignature Language="C#" Value="public object CommandSource { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="P:System.Web.UI.WebControls.FormViewCommandEventArgs.CommandSource" /> property to access the properties of the control that raised the event. In the case of a <see cref="T:System.Web.UI.WebControls.FormViewCommandEventArgs" /> object, the control is the button that was clicked by the user.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the control that raised the event.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>
|