WebPartManager.IPersonalizable.IsDirty Propiedad
Definición
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 un valor que indica si los datos de estado de personalización administrados por el control WebPartManager han cambiado en una página Web.
property bool System::Web::UI::WebControls::WebParts::IPersonalizable::IsDirty { bool get(); };bool System.Web.UI.WebControls.WebParts.IPersonalizable.IsDirty { get; }member this.System.Web.UI.WebControls.WebParts.IPersonalizable.IsDirty : bool ReadOnly Property IsDirty As Boolean Implements IPersonalizable.IsDirtyValor de propiedad
Valor booleano que indica si los datos de estado de personalización han cambiado.
Implementaciones
Ejemplos
En el ejemplo de código siguiente se muestra un uso sencillo de la IPersonalizable.IsDirty propiedad para indicar algunas instancias de personalización de página comunes que hacen que los datos de personalización de un WebPartManager control cambien.
El ejemplo de código tiene cuatro partes:
Control de usuario que permite cambiar los modos de visualización en una página que contiene controles de elementos web.
Un archivo de código fuente que contiene el código de dos controles personalizados WebPart que se pueden conectar y una interfaz.
Página web que hospeda todos los controles.
Explicación de cómo funciona el ejemplo de código.
La primera parte del ejemplo de código es el control de usuario para cambiar los modos de visualización. Puede obtener el código fuente del control de usuario en la sección Ejemplo de la información general de la WebPartManager clase. Para obtener información sobre los modos de visualización y cómo funciona el control de usuario, vea Tutorial: Cambiar modos de presentación en una página de elementos web.
La segunda parte del ejemplo es el archivo de origen con los controles personalizados y la interfaz . Observe que la IZipCode interfaz expone un método y que este método tal como se implementa en el control personalizado ZipCodeWebPart actúa como un método de devolución de llamada para permitir ZipCodeWebPart que actúe como proveedor en un escenario de conexión. El otro control, WeatherWebPart, actúa como control de consumidor en una conexión; puede consumir la interfaz determinada proporcionada por ZipCodeWebPart. En una aplicación real, WeatherWebPart podría consumir un valor de código postal personalizado del proveedor y, a continuación, proporcionar información meteorológica gráfica a 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 usa la compilación dinámica; por lo tanto, observe que la Register directiva para este componente en la parte superior de la página web contiene solo TagPrefix atributos y Namespace , sin un Assembly atributo . Para ver un tutorial que muestra cómo compilar, consulte Tutorial: Desarrollo y uso de un control de servidor web personalizado.
namespace Samples.AspNet.CS.Controls
{
using System;
using System.Web;
using System.Web.Security;
using System.Security.Permissions;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public interface IZipCode
{
string ZipCode { get; set;}
}
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public class ZipCodeWebPart : WebPart, IZipCode
{
string zipCodeText = String.Empty;
TextBox input;
Button send;
public ZipCodeWebPart()
{
}
// Make the implemented property personalizable to save
// the Zip Code between browser sessions.
[Personalizable()]
public virtual string ZipCode
{
get { return zipCodeText; }
set { zipCodeText = value; }
}
// This is the callback method that returns the provider.
[ConnectionProvider("Zip Code", "ZipCodeProvider")]
public IZipCode ProvideIZipCode()
{
return this;
}
protected override void CreateChildControls()
{
Controls.Clear();
input = new TextBox();
this.Controls.Add(input);
send = new Button();
send.Text = "Enter 5-digit Zip Code";
send.Click += new EventHandler(this.submit_Click);
this.Controls.Add(send);
}
private void submit_Click(object sender, EventArgs e)
{
if (!string.IsNullOrEmpty(input.Text))
{
zipCodeText = Page.Server.HtmlEncode(input.Text);
input.Text = String.Empty;
}
}
}
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public class WeatherWebPart : WebPart
{
private IZipCode _provider;
string _zipSearch;
Label DisplayContent;
// This method is identified by the ConnectionConsumer
// attribute, and is the mechanism for connecting with
// the provider.
[ConnectionConsumer("Zip Code", "ZipCodeConsumer")]
public void GetIZipCode(IZipCode Provider)
{
_provider = Provider;
}
protected override void OnPreRender(EventArgs e)
{
EnsureChildControls();
if (this._provider != null)
{
_zipSearch = _provider.ZipCode.Trim();
DisplayContent.Text = "My Zip Code is: " + _zipSearch;
}
}
protected override void CreateChildControls()
{
Controls.Clear();
DisplayContent = new Label();
this.Controls.Add(DisplayContent);
}
}
}
Imports System.Web
Imports System.Web.Security
Imports System.Security.Permissions
Imports System.Web.UI
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 Interface IZipCode
Property ZipCode() As String
End Interface
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class ZipCodeWebPart
Inherits WebPart
Implements IZipCode
Private zipCodeText As String = String.Empty
Private input As TextBox
Private send As Button
Public Sub New()
End Sub
' Make the implemented property personalizable to save
' the Zip Code between browser sessions.
<Personalizable()> _
Public Property ZipCode() As String _
Implements IZipCode.ZipCode
Get
Return zipCodeText
End Get
Set(ByVal value As String)
zipCodeText = value
End Set
End Property
' This is the callback method that returns the provider.
<ConnectionProvider("Zip Code", "ZipCodeProvider")> _
Public Function ProvideIZipCode() As IZipCode
Return Me
End Function
Protected Overrides Sub CreateChildControls()
Controls.Clear()
input = New TextBox()
Me.Controls.Add(input)
send = New Button()
send.Text = "Enter 5-digit Zip Code"
AddHandler send.Click, AddressOf Me.submit_Click
Me.Controls.Add(send)
End Sub
Private Sub submit_Click(ByVal sender As Object, _
ByVal e As EventArgs)
If input.Text <> String.Empty Then
zipCodeText = Page.Server.HtmlEncode(input.Text)
input.Text = String.Empty
End If
End Sub
End Class
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class WeatherWebPart
Inherits WebPart
Private _provider As IZipCode
Private _zipSearch As String
Private DisplayContent As Label
' This method is identified by the ConnectionConsumer
' attribute, and is the mechanism for connecting with
' the provider.
<ConnectionConsumer("Zip Code", "ZipCodeConsumer")> _
Public Sub GetIZipCode(ByVal Provider As IZipCode)
_provider = Provider
End Sub
Protected Overrides Sub OnPreRender(ByVal e As EventArgs)
EnsureChildControls()
If Not (Me._provider Is Nothing) Then
_zipSearch = _provider.ZipCode.Trim()
DisplayContent.Text = "My Zip Code is: " + _zipSearch
End If
End Sub
Protected Overrides Sub CreateChildControls()
Controls.Clear()
DisplayContent = New Label()
Me.Controls.Add(DisplayContent)
End Sub
End Class
End Namespace
La tercera parte del ejemplo de código es la página web. Observe que contiene dos WebPartZone zonas, con la primera que contiene los dos controles personalizados WebPart . También hay una CatalogZone zona, que contiene un control estándar Calendar que los usuarios pueden agregar a la página. El <asp:connectionszone> elemento proporciona una interfaz de usuario de conexión para que los usuarios creen conexiones entre controles. En el Page_PreRender método , observe que comprueba si los datos de personalización han cambiado y, si es así, actualiza el texto de Label1.
<%@ Page Language="C#" %>
<%@ Register TagPrefix="uc1"
TagName="DisplayModeMenuCS"
Src="~/displaymodemenucs.ascx" %>
<%@ Register TagPrefix="aspSample"
Namespace="Samples.AspNet.CS.Controls" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
protected void Page_PreRender(object sender, EventArgs e)
{
// Clear the label if it has a previously set value.
Label1.Text = String.Empty;
// Cast the WebPartManager to the IPersonalizable interface
// so that you can access the property.
IPersonalizable stateData = (IPersonalizable)mgr1;
if (stateData.IsDirty)
Label1.Text = "WebPartManager personalization data is dirty.";
}
protected void Button1_Click(object sender, EventArgs e)
{
ProviderConnectionPoint provPoint =
mgr1.GetProviderConnectionPoints(zip1)["ZipCodeProvider"];
ConsumerConnectionPoint connPoint =
mgr1.GetConsumerConnectionPoints(weather1)["ZipCodeConsumer"];
WebPartConnection conn1 = mgr1.ConnectWebParts(zip1, provPoint,
weather1, connPoint);
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>Untitled Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:WebPartManager ID="mgr1" runat="server" />
<uc1:DisplayModeMenuCS ID="menu1" runat="server" />
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<aspSample:ZipCodeWebPart ID="zip1" runat="server"
Title="Zip Code Provider" />
<aspSample:WeatherWebPart ID="weather1" runat="server"
Title="Zip Code Consumer" />
</ZoneTemplate>
</asp:WebPartZone>
<asp:WebPartZone ID="WebPartZone2" runat="server">
<ZoneTemplate>
</ZoneTemplate>
</asp:WebPartZone>
<asp:CatalogZone ID="CatalogZone1" runat="server">
<ZoneTemplate>
<asp:DeclarativeCatalogPart ID="DeclarativeCatalogPart1"
runat="server">
<WebPartsTemplate>
<asp:Calendar ID="Calendar1" runat="server"
Title="My Calendar" />
</WebPartsTemplate>
</asp:DeclarativeCatalogPart>
<asp:PageCatalogPart ID="PageCatalogPart1" runat="server" />
</ZoneTemplate>
</asp:CatalogZone>
<asp:ConnectionsZone ID="ConnectionsZone1" runat="server" />
<asp:Button ID="Button1" runat="server"
Text="Connect WebPart Controls"
OnClick="Button1_Click" />
<hr />
<asp:Label ID="Label1" runat="server"
Text=""
Font-Bold="true" />
</div>
</form>
</body>
</html>
<%@ Page Language="vb" %>
<%@ Register TagPrefix="uc1"
TagName="DisplayModeMenuVB"
Src="~/displaymodemenuvb.ascx" %>
<%@ Register TagPrefix="aspSample"
Namespace="Samples.AspNet.VB.Controls" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
Protected Sub Page_PreRender(ByVal sender As Object, _
ByVal e As System.EventArgs)
' Clear the label if it has a previously set value.
Label1.Text = String.Empty
' Cast the WebPartManager to the IPersonalizable interface
' so that you can access the property.
Dim stateData As IPersonalizable = CType(mgr1, IPersonalizable)
If stateData.IsDirty Then
Label1.Text = "WebPartManager personalization data is dirty."
End If
End Sub
Protected Sub Button1_Click(ByVal sender As Object, _
ByVal e As System.EventArgs)
Dim provPoint As ProviderConnectionPoint = _
mgr1.GetProviderConnectionPoints(zip1)("ZipCodeProvider")
Dim connPoint As ConsumerConnectionPoint = _
mgr1.GetConsumerConnectionPoints(weather1)("ZipCodeConsumer")
Dim conn1 As WebPartConnection = _
mgr1.ConnectWebParts(zip1, provPoint, weather1, connPoint)
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>Untitled Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:WebPartManager ID="mgr1" runat="server" />
<uc1:DisplayModeMenuVB ID="menu1" runat="server" />
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<aspSample:ZipCodeWebPart ID="zip1" runat="server"
Title="Zip Code Provider" />
<aspSample:WeatherWebPart ID="weather1" runat="server"
Title="Zip Code Consumer" />
</ZoneTemplate>
</asp:WebPartZone>
<asp:WebPartZone ID="WebPartZone2" runat="server">
<ZoneTemplate>
</ZoneTemplate>
</asp:WebPartZone>
<asp:CatalogZone ID="CatalogZone1" runat="server">
<ZoneTemplate>
<asp:DeclarativeCatalogPart ID="DeclarativeCatalogPart1"
runat="server">
<WebPartsTemplate>
<asp:Calendar ID="Calendar1" runat="server"
Title="My Calendar" />
</WebPartsTemplate>
</asp:DeclarativeCatalogPart>
<asp:PageCatalogPart ID="PageCatalogPart1" runat="server" />
</ZoneTemplate>
</asp:CatalogZone>
<asp:ConnectionsZone ID="ConnectionsZone1" runat="server" />
<asp:Button ID="Button1" runat="server"
Text="Connect WebPart Controls"
OnClick="Button1_Click" />
<hr />
<asp:Label ID="Label1" runat="server"
Text=""
Font-Bold="true" />
</div>
</form>
</body>
</html>
Después de cargar la página en un explorador, intente crear algunos de los escenarios enumerados en la sección Comentarios de este tema que cambiará los datos de personalización. A medida que realiza varios cambios, cuando un cambio implica uno de los escenarios de personalización de los que realiza el seguimiento el WebPartManager control, se muestra el texto del control para indicar que los datos de Label1 personalización han cambiado. Por ejemplo, puede:
Cree una conexión entre controles haciendo clic en el botón Conectar controles de elemento web .
Use el control de lista desplegable Modo de visualización para cambiar la página al modo de catálogo y agregue el control Mi calendario a la segunda WebPartZone zona.
Vuelva a cambiar la página al modo de exploración, haga clic en el menú verbos (que se muestra con un símbolo de flecha en la barra de título) para el control Mi calendario y seleccione Cerrar para cerrarlo y agregarlo al catálogo de páginas.
Vuelva a la página al modo de catálogo y vuelva a agregar el control Mi calendario a la página.
Utilice el control Modo de presentación para cambiar la página al modo de diseño y reorganizar el diseño de los controles arrastrando uno o varios de ellos a otra zona, o a una posición diferente en la misma zona.
Comentarios
La IPersonalizable.IsDirty propiedad proporciona una manera de que los autores de llamadas determinen si los datos de estado de personalización administrados por el WebPartManager control han cambiado. Cuando los usuarios personalizan los detalles de nivel de página, por ejemplo, cambiando el diseño de página, creando o eliminando conexiones y agregando o eliminando controles, los datos de personalización administrados por el WebPartManager control cambian. Se trata de un método de paso a través que devuelve a los llamadores el valor de la propiedad protegida IsCustomPersonalizationStateDirty , a la que no pueden acceder directamente los autores de llamadas.
Nota
La IPersonalizable.IsDirty propiedad no indica si los valores de propiedad personalizables o las propiedades individuales que afectan a la apariencia de los controles individuales WebPart han cambiado. Se realiza un seguimiento de la personalización de nivel de control para cada control individualmente. La IPersonalizable.IsDirty propiedad indica solo si los datos de personalización que están en el nivel de página y los administra el WebPartManager control han cambiado.
En la lista siguiente se describen algunas instancias comunes de personalización que harían que la IPersonalizable.IsDirty propiedad devuelva un valor de true, lo que indica que el WebPartManager control tiene algunos datos de personalización modificados:
Cerrar un control estático WebPart (o servidor o control de usuario) en una página.
Restaurar un control estático cerrado WebPart desde un catálogo de páginas a una página.
Mover cualquier control dentro de su zona o a otra zona.
Agregar un control desde un catálogo de controles de WebPart servidor o agregar un control mediante programación.
Crear una conexión entre dos WebPart controles, ya sea mediante programación o mediante la interfaz de usuario (UI) de conexión.
Eliminar una conexión entre dos WebPart controles, ya sea mediante programación o mediante la interfaz de usuario de conexión.
Para tener acceso a este valor de propiedad, debe convertir la WebPartManager instancia de control en la IPersonalizable interfaz; a continuación, puede leer el valor de la IsDirty propiedad.
