-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
FormViewCommandEventHandler.xml
78 lines (66 loc) · 7 KB
/
FormViewCommandEventHandler.xml
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
<Type Name="FormViewCommandEventHandler" FullName="System.Web.UI.WebControls.FormViewCommandEventHandler">
<TypeSignature Language="C#" Value="public delegate void FormViewCommandEventHandler(object sender, FormViewCommandEventArgs e);" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed FormViewCommandEventHandler extends System.MulticastDelegate" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.FormViewCommandEventHandler" />
<TypeSignature Language="VB.NET" Value="Public Delegate Sub FormViewCommandEventHandler(sender As Object, e As FormViewCommandEventArgs)" />
<TypeSignature Language="F#" Value="type FormViewCommandEventHandler = delegate of obj * FormViewCommandEventArgs -> unit" />
<TypeSignature Language="C++ CLI" Value="public delegate void FormViewCommandEventHandler(System::Object ^ sender, FormViewCommandEventArgs ^ e);" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="System.Web.UI.WebControls.FormViewCommandEventArgs" />
</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.Web.UI.WebControls.FormViewCommandEventArgs" /> that contains the event data.</param>
<summary>Represents the method that handles the <see cref="E:System.Web.UI.WebControls.FormView.ItemCommand" /> event of a <see cref="T:System.Web.UI.WebControls.FormView" /> control. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.FormView.ItemCommand> event is raised when a button within the <xref: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.
Buttons within a <xref: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.
|CommandName value|Description|
|-----------------------|-----------------|
|"Cancel"|Cancels an edit or insert operation and returns the <xref:System.Web.UI.WebControls.FormView> control to the mode specified by the <xref:System.Web.UI.WebControls.FormView.DefaultMode%2A> property. Raises the <xref:System.Web.UI.WebControls.FormView.ModeChanged> and <xref:System.Web.UI.WebControls.FormView.ModeChanging> events.|
|"Delete"|Deletes the current record. Raises the <xref:System.Web.UI.WebControls.FormView.ItemDeleted> and <xref:System.Web.UI.WebControls.FormView.ItemDeleting> events.|
|"Edit"|Puts the <xref:System.Web.UI.WebControls.FormView> control in edit mode. Raises the <xref:System.Web.UI.WebControls.FormView.ModeChanged> and <xref:System.Web.UI.WebControls.FormView.ModeChanging> events.|
|"Insert"|Inserts the current record in the data source. Raises the <xref:System.Web.UI.WebControls.FormView.ItemInserted> and <xref:System.Web.UI.WebControls.FormView.ItemInserting> events.|
|"New"|Puts the <xref:System.Web.UI.WebControls.FormView> control in insert mode. Raises the <xref:System.Web.UI.WebControls.FormView.ModeChanged> and <xref:System.Web.UI.WebControls.FormView.ModeChanging> events.|
|"Page"|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 <xref:System.Web.UI.WebControls.FormView.PageIndexChanged> and <xref:System.Web.UI.WebControls.FormView.PageIndexChanging> events.|
|"Update"|Updates the current record in the data source. Raises the <xref:System.Web.UI.WebControls.FormView.ItemUpdated> and <xref:System.Web.UI.WebControls.FormView.ItemUpdating> events.|
Although the <xref:System.Web.UI.WebControls.FormView.ItemCommand> event is raised when a button listed in the previous table is clicked, it is recommended that you handle the events listed in the table for the operation.
When you create a <xref:System.Web.UI.WebControls.FormViewCommandEventHandler> 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 example demonstrates how to programmatically add a <xref:System.Web.UI.WebControls.FormViewCommandEventHandler> delegate to the <xref:System.Web.UI.WebControls.FormView.ItemCommand> event of a <xref:System.Web.UI.WebControls.FormView> control.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/FormViewCommandEventHandler/CS/formviewcommandeventhandlercs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/FormViewCommandEventHandler/VB/formviewcommandeventhandlervb.aspx" id="Snippet1":::
The following example demonstrates how to declaratively add a <xref:System.Web.UI.WebControls.FormViewCommandEventHandler> delegate to the <xref:System.Web.UI.WebControls.FormView.ItemCommand> event of a <xref:System.Web.UI.WebControls.FormView> control.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/FormViewCommandEventHandlerDeclarative/CS/formviewcommandeventhandlerdeclarativecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/FormViewCommandEventHandlerDeclarative/VB/formviewcommandeventhandlerdeclarativevb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.FormView" />
<altmember cref="E:System.Web.UI.WebControls.FormView.ItemCommand" />
<altmember cref="M:System.Web.UI.WebControls.FormView.OnItemCommand(System.Web.UI.WebControls.FormViewCommandEventArgs)" />
<altmember cref="T:System.Web.UI.WebControls.FormViewCommandEventArgs" />
<altmember cref="T:System.Web.UI.WebControls.CommandEventArgs" />
<altmember cref="E:System.Web.UI.WebControls.FormView.ItemDeleted" />
<altmember cref="E:System.Web.UI.WebControls.FormView.ItemDeleting" />
<altmember cref="E:System.Web.UI.WebControls.FormView.ItemInserted" />
<altmember cref="E:System.Web.UI.WebControls.FormView.ItemInserting" />
<altmember cref="E:System.Web.UI.WebControls.FormView.ItemUpdated" />
<altmember cref="E:System.Web.UI.WebControls.FormView.ItemUpdating" />
<altmember cref="E:System.Web.UI.WebControls.FormView.PageIndexChanged" />
<altmember cref="E:System.Web.UI.WebControls.FormView.PageIndexChanging" />
</Docs>
</Type>