Export (0) Print
Expand All

WebPartZoneBase.RestoreVerb Property

Gets a reference to a WebPartVerb object that enables end users to restore WebPart controls in a zone to normal size.

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

[PersistenceModeAttribute(PersistenceMode.InnerProperty)]
public virtual WebPartVerb RestoreVerb { get; }

Property Value

Type: System.Web.UI.WebControls.WebParts.WebPartVerb
A WebPartVerb that enables end users to restore WebPart controls.

The restore verb referenced by the RestoreVerb property appears within the verbs menu of each WebPart control in a zone, when a control is minimized. The verb appears in the menu in all page display modes.

Restoring a control expands it back to its normal size after the control has been previously minimized.

The following code example demonstrates the use of the RestoreVerb 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 restore 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;
        break;
      case "export":
        theVerb = WebPartZone1.ExportVerb;
        break;
      case "delete":
        theVerb = WebPartZone1.DeleteVerb;
        break;
      case "minimize":
        theVerb = WebPartZone1.MinimizeVerb;
        break;
      case "restore":
        theVerb = WebPartZone1.RestoreVerb;
        break;
      default:
        theVerb = null;
        break;
    }

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

The other part of the code example is the Web page that hosts the custom WebPart control and contains the user interface (UI). Notice that the declarative <RestoreVerb> element in the zone sets the value for the Description attribute text, which appears as a ToolTip when a user positions the mouse pointer over the verb in the verbs menu.

<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" />
  <ZoneTemplate>
  </ZoneTemplate>  
</asp:WebPartZone>

After you load the page in a browser, switch the page into catalog display mode, and add the TextDisplayWebPart control to the page, if it has not been added. Use the minimize verb to minimize the control, and note that the restore verb becomes visible. You can use the check boxes to enable and disable the restore verb.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft