-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
WebPartVerbsEventHandler.xml
46 lines (40 loc) · 4.19 KB
/
WebPartVerbsEventHandler.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
<Type Name="WebPartVerbsEventHandler" FullName="System.Web.UI.WebControls.WebParts.WebPartVerbsEventHandler">
<TypeSignature Language="C#" Value="public delegate void WebPartVerbsEventHandler(object sender, WebPartVerbsEventArgs e);" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed WebPartVerbsEventHandler extends System.MulticastDelegate" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.WebParts.WebPartVerbsEventHandler" />
<TypeSignature Language="VB.NET" Value="Public Delegate Sub WebPartVerbsEventHandler(sender As Object, e As WebPartVerbsEventArgs)" />
<TypeSignature Language="F#" Value="type WebPartVerbsEventHandler = delegate of obj * WebPartVerbsEventArgs -> unit" />
<TypeSignature Language="C++ CLI" Value="public delegate void WebPartVerbsEventHandler(System::Object ^ sender, WebPartVerbsEventArgs ^ 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.WebParts.WebPartVerbsEventArgs" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Docs>
<param name="sender">The source of the event.</param>
<param name="e">The event arguments.</param>
<summary>Represents the delegate for the <see cref="E:System.Web.UI.WebControls.WebParts.WebPartZoneBase.CreateVerbs" /> event.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.WebParts.WebPartVerbsEventHandler> class is used to specify the methods that are invoked in response to a <xref:System.Web.UI.WebControls.WebParts.WebPartZoneBase.CreateVerbs> event, which occurs when the Web Parts verbs are created for a zone that derives from the <xref:System.Web.UI.WebControls.WebParts.WebPartZoneBase> class.
Web Parts verbs represent actions that users can perform in the user interface (UI) of a Web Parts page, such as minimizing, closing, or restoring controls; adding controls to a page; or canceling an action. Verbs can appear in both the header and footer areas of a zone, and there are both standard verbs provided with the Web Parts control set, and custom verbs that can be added by developers. A verb is represented in the UI by a clickable object, which you can set to appear as a hyperlink, an image, or a button, by using the <xref:System.Web.UI.WebControls.WebParts.WebPartZoneBase.VerbButtonType%2A> property.
A <xref:System.Web.UI.WebControls.WebParts.WebPartZone> zone provides a standard set of verbs that get rendered in a Web Parts control's verbs menu. A custom Web Parts zone, or a Web Parts control inside a Web Parts zone, can add additional verbs to the menu.
A control in a Web Parts zone can add verbs to the control's verbs menu by inheriting from the <xref:System.Web.UI.WebControls.WebParts.WebPart> base class and overriding the <xref:System.Web.UI.WebControls.WebParts.WebPart.Verbs%2A> property. If the control does not inherit from the <xref:System.Web.UI.WebControls.WebParts.WebPart> base class, you can add a new verb by implementing the <xref:System.Web.UI.WebControls.WebParts.IWebActionable> interface, and then overriding the <xref:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs%2A> collection.
The protected <xref:System.Web.UI.WebControls.WebParts.WebPartZoneBase.OnCreateVerbs%2A?displayProperty=nameWithType> method allows derived classes to override the event without attaching a delegate to it. A derived class must always call the <xref:System.Web.UI.WebControls.WebParts.WebPartZoneBase.OnCreateVerbs%2A> method of the base class to ensure that registered delegates receive the event.
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/y3bwdsh3(v=vs.100)">ASP.NET Server Control Event Model</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/e0s9t4ck(v=vs.100)">ASP.NET Web Parts Controls</related>
</Docs>
</Type>