System.Web.UI.WebControls.WebParts.IWebActionable

Enables System.Web.UI.WebControls.WebParts.WebPart controls or other server controls to contain collections of verbs.

See Also: IWebActionable Members

Syntax

public interface IWebActionable

Remarks

A verb in 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 System.Web.UI.WebControls.WebParts.WebPart controls and other server controls (such as custom, ASP.NET, and user controls) that can act like System.Web.UI.WebControls.WebParts.WebPart controls when placed in System.Web.UI.WebControls.WebParts.WebPartZoneBase zones. Standard verbs include close, minimize, restore, delete, edit, and export.

You can also create custom verbs for use with System.Web.UI.WebControls.WebParts.WebPart and server controls. The System.Web.UI.WebControls.WebParts.IWebActionable interface, with its IWebActionable.Verbs property, gives you a way to integrate custom verbs into your controls. The System.Web.UI.WebControls.WebParts.WebPart class implements the System.Web.UI.WebControls.WebParts.IWebActionable interface and implements its single property. To add custom verbs to a control that inherits from the System.Web.UI.WebControls.WebParts.WebPart class, you must override the WebPart.Verbs property, add custom verbs to a collection, and return the collection. The collection referenced by the WebPart.Verbs property contains only custom verbs; standard verbs are not included in this collection. The default return value of the WebPart.Verbs property in a System.Web.UI.WebControls.WebParts.WebPart control is null, because by default there are no custom verbs in the collection.

Adding custom verbs to server controls that are not System.Web.UI.WebControls.WebParts.WebPart controls requires one extra step. In those cases, the controls must also implement the System.Web.UI.WebControls.WebParts.IWebActionable interface and implement the IWebActionable.Verbs property.

After you have added custom verbs to the IWebActionable.Verbs collection, the Web Parts control set automatically handles the other steps necessary to create and render the custom verbs.

Requirements

Namespace: System.Web.UI.WebControls.WebParts
Assembly: System.Web (in System.Web.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0