CloseVerb Property

WebPartZoneBase.CloseVerb Property


Gets a reference to a WebPartVerb object that enables end users to close the WebPart controls in a zone.

Namespace:   System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

public virtual WebPartVerb CloseVerb { get; }

Property Value

Type: System.Web.UI.WebControls.WebParts.WebPartVerb

A WebPartVerb that enables end users to close WebPart controls.

The close verb referenced by the CloseVerb property appears in the verbs menu of each WebPart control in a zone.

Closing a control removes it from interaction on a page, although if developers provide the appropriate user interface (UI), such as a CatalogZone zone that contains a PageCatalogPart control, a user can switch the page into CatalogDisplayMode and add a previously closed instance of a control back to the page.

The following code example demonstrates the use of the CloseVerb property on a WebPartZone control. For the code example to work, you need all the code from the Example section of the HelpVerb property.

The following part of the code example is from the partial class, and contains the code that toggles whether the help verb is enabled or disabled.

protected void CheckBoxList1_SelectedItemIndexChanged(Object sender, EventArgs e)
  foreach (ListItem item in CheckBoxList1.Items)
    WebPartVerb theVerb;
    switch (item.Value)
      case "close":
        theVerb = WebPartZone1.CloseVerb;
      case "export":
        theVerb = WebPartZone1.ExportVerb;
      case "delete":
        theVerb = WebPartZone1.DeleteVerb;
      case "minimize":
        theVerb = WebPartZone1.MinimizeVerb;
      case "restore":
        theVerb = WebPartZone1.RestoreVerb;
        theVerb = null;

    if (item.Selected)
      theVerb.Enabled = true;
      theVerb.Enabled = false;

The other part of the code example is the Web page that hosts the custom control and contains the UI. Notice that the declarative <CloseVerb> element in the zone sets the specific text that represents the close verb in the verbs menu for the WebPart control.

<asp:WebPartZone ID="WebPartZone1" Runat="server">
  <CloseVerb Text="Close WebPart" />
  <HelpVerb Text="View Help" />
  <ExportVerb Text="Export WebPart Definition" />
  <DeleteVerb Text ="Delete WebPart" />
  <MinimizeVerb Description="Minimize the control" />
  <RestoreVerb Description="Restore the control" />

Notice also that, because the underlying custom WebPart control--named TextDisplayWebPart-- used in the code example sets the AllowClose property to false in its constructor, the <aspSample:TextDisplayPart> element in the catalog must set the AllowClose property to true, so that the control can be closed in the following code example.

<asp:CatalogZone ID="CatalogZone1" Runat="server">
    <asp:DeclarativeCatalogPart ID="DeclarativeCatalogPart1" 
          title = "Text Content WebPart" 
          HelpUrl="TextWebPartHelp.htm" />            
    <asp:PageCatalogPart ID="PageCatalogPart1" Runat="server" />

After you load the page in a browser, switch the page into catalog display mode, and add the TextDisplayWebPart control to the page. You can use the check boxes to enable and disable the close verb, and you can click the Close WebPart verb in the verbs menu to close the control. After you close the control, if you return the page to catalog display mode, you can click the Page Catalog, select the original instance of the TextDisplayWebPart control that you closed, and reopen it on the page.

.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft