49 lines
6.0 KiB
XML
49 lines
6.0 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="IWebActionable" FullName="System.Web.UI.WebControls.WebParts.IWebActionable">
|
|
<TypeSignature Language="C#" Value="public interface IWebActionable" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Web</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Interfaces />
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A verb in <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls is an action that a user can carry out in the user interface (UI). Typically, a verb is represented in the UI by a clickable control such as a button, a link, or a menu item. The Web Parts control set provides standard verbs that are available by default to <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls and other server controls (such as custom, ASP.NET, and user controls) that can act like <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls when placed in <see cref="T:System.Web.UI.WebControls.WebParts.WebPartZoneBase" /> zones. Standard verbs include close, minimize, restore, delete, edit, and export.</para>
|
|
<para>You can also create custom verbs for use with <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> and server controls. The <see cref="T:System.Web.UI.WebControls.WebParts.IWebActionable" /> interface, with its <see cref="P:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs" /> property, gives you a way to integrate custom verbs into your controls. The <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> class implements the <see cref="T:System.Web.UI.WebControls.WebParts.IWebActionable" /> interface and implements its single property. To add custom verbs to a control that inherits from the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> class, you must override the <see cref="P:System.Web.UI.WebControls.WebParts.WebPart.Verbs" /> property, add custom verbs to a collection, and return the collection. The collection referenced by the <see cref="P:System.Web.UI.WebControls.WebParts.WebPart.Verbs" /> property contains only custom verbs; standard verbs are not included in this collection. The default return value of the <see cref="P:System.Web.UI.WebControls.WebParts.WebPart.Verbs" /> property in a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control is null, because by default there are no custom verbs in the collection.</para>
|
|
<para>Adding custom verbs to server controls that are not <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls requires one extra step. In those cases, the controls must also implement the <see cref="T:System.Web.UI.WebControls.WebParts.IWebActionable" /> interface and implement the <see cref="P:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs" /> property.</para>
|
|
<para>After you have added custom verbs to the <see cref="P:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs" /> collection, the Web Parts control set automatically handles the other steps necessary to create and render the custom verbs.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Enables <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> controls or other server controls to contain collections of verbs.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName="Verbs">
|
|
<MemberSignature Language="C#" Value="public System.Web.UI.WebControls.WebParts.WebPartVerbCollection Verbs { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Web.UI.WebControls.WebParts.WebPartVerbCollection</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs" /> property references a collection of custom verbs (if any) that are added to a verbs menu in the header of a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> or other server control. The <see cref="P:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs" /> collection does not contain references to the standard <see cref="T:System.Web.UI.WebControls.WebParts.WebPartVerb" /> objects provided with the Web Parts control set, such as <see cref="P:System.Web.UI.WebControls.WebParts.WebPartZoneBase.CloseVerb" />, <see cref="P:System.Web.UI.WebControls.WebParts.WebPartZoneBase.DeleteVerb" />, <see cref="P:System.Web.UI.WebControls.WebParts.WebPartZoneBase.EditVerb" />, <see cref="P:System.Web.UI.WebControls.WebParts.WebPartZoneBase.RestoreVerb" />, or <see cref="P:System.Web.UI.WebControls.WebParts.WebPartZoneBase.MinimizeVerb" />.</para>
|
|
<para>Developers who want to add custom verbs to a custom control that derives from the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> class can simply override the <see cref="P:System.Web.UI.WebControls.WebParts.WebPart.Verbs" /> property that the <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> class implements.</para>
|
|
<para>Developers who want to add custom verbs to a user control, or a custom control that is not a <see cref="T:System.Web.UI.WebControls.WebParts.WebPart" /> control, must implement the <see cref="T:System.Web.UI.WebControls.WebParts.IWebActionable" /> interface by providing an implementation of the <see cref="P:System.Web.UI.WebControls.WebParts.IWebActionable.Verbs" /> property. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets a reference to a collection of custom <see cref="T:System.Web.UI.WebControls.WebParts.WebPartVerb" /> objects.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |