WebPart.AllowMinimize Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets a value indicating whether end users can minimize a WebPart control.

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

public virtual bool AllowMinimize { get; set; }

Property Value

Type: System.Boolean

true if the WebPart control can be minimized; otherwise, false. The default value is true.

The AllowMinimize property, if set to false, prevents an end user from being able to minimize the control, and the user interface (UI) for minimizing the control does not appear in the control's title bar. In Web Parts terminology, when the AllowMinimize property is set to false, the minimize verb does not appear on the control's verbs menu.

When a user minimizes a control, it reduces the control's size down to a minimal area that displays only part of the control's title bar and title.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

The personalization scope of this property is set to Shared and can be modified only by authorized users. For more information, see PersonalizableAttribute and Web Parts Personalization Overview.

The following code example demonstrates how to change the default setting of the AllowMinimize property for a custom Web Parts control, so that the control cannot be minimized by a user. This example assumes the use of a custom WebPart control, TextDisplayWebPart, which is found in the Example section of the WebPart class overview.

In the declarative markup for the Web page, on the <aspSample:TextDisplayWebPart> element that references the control, note the AllowMinimize="false" attribute, which hides the minimize verb in the WebPart control's verbs menu, and prevents a user from being able to minimize the control. Load the page in a browser, and click the verbs menu on the WebPart control. The minimize verb, which would normally be present on the verbs menu, is hidden because you disabled it in the declarative markup for the control.

<%@ page language="C#" %>
<%@ register tagprefix="aspSample" 

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
      title="Zone 1"
        <parttitlestyle font-bold="true" ForeColor="#3300cc" />
          bordercolor="#81AAF2" />
            title = "Text Content WebPart" 
            AllowMinimize="false" />

.NET Framework
Available since 2.0
Return to top