WebPart.AllowClose Propiedad

Referencia

Definición

Espacio de nombres:: System.Web.UI.WebControls.WebParts

Ensamblado:: System.Web.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Obtiene o establece un valor que indica si un usuario final puede cerrar un control WebPart en una página Web.

public:
 virtual property bool AllowClose { bool get(); void set(bool value); };

[System.Web.UI.Themeable(false)]
[System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)]
public virtual bool AllowClose { get; set; }

[<System.Web.UI.Themeable(false)>]
[<System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)>]
member this.AllowClose : bool with get, set

Public Overridable Property AllowClose As Boolean

Valor de propiedad

Boolean

true si el control puede cerrarse en la página Web; en caso contrario, false. El valor predeterminado es true.

Atributos: ThemeableAttribute PersonalizableAttribute

Ejemplos

En el ejemplo de código siguiente se muestra cómo cambiar la configuración predeterminada de la AllowClose propiedad para un control personalizado WebPart , de modo que no se pueda cerrar.

La primera parte de este ejemplo contiene el código de un control personalizado WebPart denominado TextDisplayWebPart. Tenga en cuenta que, en el constructor del control personalizado, la TextDisplayWebPart.AllowClose propiedad se establece falseen , que tiene el efecto de impedir que los usuarios cierren el control en una página web. Esto significa que el verbo close del menú verbo del control se deshabilitará para los usuarios. Para que se ejecute el ejemplo de código, debe compilar este código fuente. Puede compilarlo explícitamente y colocar el ensamblado resultante en la carpeta Bin del sitio web o en la caché global de ensamblados. Como alternativa, puede colocar el código fuente en la carpeta App_Code del sitio, donde se compilará dinámicamente en tiempo de ejecución. En este ejemplo de código se supone que se compila el código fuente en un ensamblado, se coloca en una subcarpeta Bin de la aplicación web y se hace referencia al ensamblado con una Register directiva en la página web. Para ver un tutorial que muestra ambos métodos de compilación, vea Walkthrough: Developing and Using a Custom Web Server Control.

using System;
using System.Security.Permissions;
using System.Web;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

namespace Samples.AspNet.CS.Controls
{
  [AspNetHostingPermission(SecurityAction.Demand, 
    Level=AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand, 
    Level=AspNetHostingPermissionLevel.Minimal)]
  public class TextDisplayWebPart : WebPart
  {
    private String _contentText = null;
    TextBox input;
    Label DisplayContent;

    public TextDisplayWebPart()
    {
      this.AllowClose = false;
    }

    [Personalizable(), WebBrowsable]
    public String ContentText
    {
      get { return _contentText; }
      set { _contentText = value; }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      DisplayContent.BackColor = 
        System.Drawing.Color.LightBlue;
      DisplayContent.Text = this.ContentText;
      this.Controls.Add(DisplayContent);
      input = new TextBox();
      this.Controls.Add(input);
      Button update = new Button();
      update.Text = "Set Label Content";
      update.Click += new EventHandler(this.submit_Click);
      this.Controls.Add(update);
      ChildControlsCreated = true;
    }

    private void submit_Click(object sender, EventArgs e)
    {
      // Update the label string.
      if (!string.IsNullOrEmpty(input.Text))
      {
        _contentText = input.Text + @"<br />";
        input.Text = String.Empty;
        DisplayContent.Text = this.ContentText;
      }
    }
  }
}

Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts

Namespace Samples.AspNet.VB.Controls

<AspNetHostingPermission(SecurityAction.Demand, _
  Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
  Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class TextDisplayWebPart
    Inherits WebPart
    Private _contentText As String = Nothing
    Private input As TextBox
    Private DisplayContent As Label
    
    
    Public Sub New() 
      Me.AllowClose = False
    End Sub
    
    <Personalizable(), WebBrowsable()>  _
    Public Property ContentText() As String 
        Get
            Return _contentText
        End Get
        Set
            _contentText = value
        End Set
    End Property
     
    Protected Overrides Sub CreateChildControls() 
        Controls.Clear()
        DisplayContent = New Label()
        DisplayContent.Text = Me.ContentText
        DisplayContent.BackColor = _
          System.Drawing.Color.LightBlue
        Me.Controls.Add(DisplayContent)
        input = New TextBox()
        Me.Controls.Add(input)
        Dim update As New Button()
        update.Text = "Set Label Content"
        AddHandler update.Click, AddressOf Me.submit_Click
        Me.Controls.Add(update)
        ChildControlsCreated = True
    
    End Sub
    
    
    Private Sub submit_Click(ByVal sender As Object, _
                             ByVal e As EventArgs) 
        ' Update the label string.
        If input.Text <> String.Empty Then
            _contentText = input.Text & "<br />"
            input.Text = String.Empty
            DisplayContent.Text = Me.ContentText
        End If
    
    End Sub
    
End Class

End Namespace

La segunda parte del ejemplo muestra cómo hacer referencia al TextDisplayWebPart control en una página web de ASP.NET. Tenga en cuenta que en el <aspSample:TextDisplayWebPart> elemento que hace referencia al control, también puede cambiar el valor de la propiedad establecida por el constructor del control. Para permitir que el control se cierre, basta con agregar un AllowClose="true" atributo al elemento en el marcado declarativo.

<%@ page language="C#" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.CS.Controls" 
             Assembly="TextDisplayWebPartCS"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      title="Zone 1"
      PartChromeType="TitleAndBorder">
        <parttitlestyle font-bold="true" ForeColor="#3300cc" />
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

<%@ page language="VB" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.VB.Controls" 
             Assembly="TextDisplayWebPartVB"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      title="Zone 1"
      PartChromeType="TitleAndBorder">
        <parttitlestyle font-bold="true" ForeColor="#3300cc" />
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

Comentarios

Una vez que un usuario cierra un WebPart control en una página web, el control ya no está visible o disponible en la página. El control cerrado se agrega al catálogo de páginas, una entidad elementos web que almacena una referencia al control . Si un desarrollador agrega un PageCatalogPart control a la página dentro de un CatalogZone control, los usuarios podrán cambiar la página al modo de presentación del catálogo, seleccionar el control cerrado en el catálogo de páginas y volver a agregarlo a la página.

Nota

Un control cerrado WebPart se puede volver a agregar a una página mediante programación o a un usuario que selecciona el control cerrado del catálogo de páginas cuando la página está en modo de presentación de catálogo.

Cerrar un WebPart control es diferente de eliminarlo. Un control cerrado se puede volver a agregar a una página, mientras que un control eliminado se quita permanentemente. Para obtener más información sobre cómo eliminar controles, vea el DeleteWebPart método . Cerrar un control también es diferente de ocultarlo. Un control que está oculto todavía está presente en la página, sigue participando en los eventos del ciclo de vida de la página y solo está oculto de la vista del usuario, pero un control cerrado ni siquiera se representa en una página.

Los controles estáticos y dinámicos WebPart (los controles estáticos se declaran en el marcado de una página, mientras que los controles dinámicos se agregan mediante programación) se pueden cerrar.

Si un desarrollador establece la AllowClose propiedad falseen , un verbo close no aparece en el control y el usuario no puede cerrar el control.

Esta propiedad no se puede establecer mediante temas o temas de la hoja de estilos. Para obtener más información, vea ThemeableAttribute y ASP.NET Temas y máscaras.

El ámbito de personalización de esta propiedad se establece Shared en y solo los usuarios autorizados pueden modificarlos. Para obtener más información, consulte PersonalizableAttribute y elementos web Información general sobre personalización.

Se aplica a

Share via