WebPartManager.IPersonalizable.IsDirty Propriedade
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Obtém um valor que indica se os dados de estado de personalização customizados, gerenciados pelo controle WebPartManager, foram alterados em uma página da 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 da propriedade
Um valor booliano que indica se os dados de estado de personalização foram alterados.
Implementações
Exemplos
O exemplo de código a seguir demonstra um uso simples da IPersonalizable.IsDirty propriedade, para indicar algumas instâncias comuns de personalização de página que fazem com que os dados de personalização de um WebPartManager controle sejam alterados.
O exemplo de código tem quatro partes:
Um controle de usuário que permite alterar os modos de exibição em uma página que contém controles Web Parts.
Um arquivo de origem que contém o código para dois controles personalizados WebPart que podem ser conectados e uma interface.
Uma página da Web que hospeda todos os controles.
Uma explicação de como o exemplo de código funciona.
A primeira parte do exemplo de código é o controle do usuário para alterar os modos de exibição. Você pode obter o código-fonte para o controle do usuário na seção Exemplo da visão geral da WebPartManager classe. Para obter informações sobre modos de exibição e como funciona o controle do usuário, consulte Passo a passo: Alterando os modos de exibição em uma página de Web Parts.
A segunda parte do exemplo é o arquivo de origem com os controles personalizados e a interface. Observe que a IZipCode interface expõe um método e que esse método, conforme implementado no controle personalizado ZipCodeWebPart , serve como um método de retorno de chamada para permitir atuar ZipCodeWebPart como um provedor em um cenário de conexão. O outro controle, WeatherWebPartatua como o controle do consumidor em uma conexão; ele pode consumir a interface específica fornecida por ZipCodeWebPart. Em um aplicativo real, WeatherWebPart poderia consumir um valor personalizado de CEP do provedor e, em seguida, fornecer informações gráficas de clima aos usuários.
Para que o exemplo de código seja executado, você deve compilar esse código-fonte. Você pode compilá-lo explicitamente e colocar o assembly resultante na pasta Bin do seu site ou no cache de assembly global. Como alternativa, você pode colocar o código-fonte na pasta App_Code do seu site, onde ele será compilado dinamicamente em tempo de execução. Este exemplo de código usa compilação dinâmica; portanto, observe que a Register diretiva para esse componente na parte superior da página da Web contém apenas TagPrefix e Namespace atributos, sem um Assembly atributo. Para obter um passo a passo que demonstra como compilar, consulte Passo a passo: Desenvolvendo e usando um controle 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
A terceira parte do exemplo de código é a página da Web. Observe que ele contém duas WebPartZone zonas, com a primeira contendo os dois controles personalizados WebPart . Há também uma CatalogZone zona que contém um controle padrão Calendar que os usuários podem adicionar à página. O <asp:connectionszone> elemento fornece uma interface do usuário de conexão para que os usuários criem conexões entre controles. Page_PreRender No método, observe que ele verifica se os dados de personalização foram alterados e, em caso afirmativo, atualiza o 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>
Depois de carregar a página em um navegador, tente criar alguns dos cenários listados na seção Comentários deste tópico que alterarão os dados de personalização. Conforme você faz várias alterações, quando uma alteração envolve um dos cenários de personalização rastreados pelo WebPartManager controle, o texto do controle é exibido para indicar que os Label1 dados de personalização foram alterados. Por exemplo, você pode:
Crie uma conexão entre controles clicando no botão Conexão controles WebPart.
Use o controle de lista suspensa Modo de Exibição para alternar a página para o modo de catálogo e adicionar o controle Meu Calendário à segunda WebPartZone zona.
Altere a página de volta para o modo de navegação, clique no menu de verbos (mostrado com um símbolo de seta na barra de título) para o controle Meu Calendário e selecione Fechar para fechá-lo e adicioná-lo ao catálogo de páginas.
Retorne a página ao modo de catálogo e adicione o controle Meu Calendário de volta à página.
Use o controle Modo de Exibição para alternar a página para o modo de design e reorganizar o layout dos controles arrastando um ou mais deles para outra zona ou para uma posição diferente na mesma zona.
Comentários
A IPersonalizable.IsDirty propriedade fornece uma maneira de os chamadores determinarem se os WebPartManager dados de estado de personalização gerenciados pelo controle foram alterados. Quando os usuários personalizam detalhes no nível da página, por exemplo, alterando o layout da página, criando ou excluindo conexões e adicionando ou excluindo controles, os dados de personalização gerenciados pelo WebPartManager controle são alterados. Esse é um método de passagem que retorna aos chamadores o valor da propriedade protegida IsCustomPersonalizationStateDirty , que não pode ser acessado diretamente pelos chamadores.
Observação
A IPersonalizable.IsDirty propriedade não indica se valores de propriedade personalizáveis ou propriedades individuais que afetam a aparência de controles individuais WebPart foram alterados. A personalização no nível de controle é controlada para cada controle individualmente. A IPersonalizable.IsDirty propriedade indica apenas se os WebPartManager dados de personalização que estão no nível da página e que são gerenciados pelo controle foram alterados.
A lista a seguir descreve algumas instâncias comuns de personalização que fariam com que a IPersonalizable.IsDirty propriedade retornasse um valor, trueindicando que o WebPartManager controle tem alguns dados de personalização alterados:
Fechando um controle estático WebPart (ou servidor ou controle de usuário) em uma página.
Restaurando um controle estático WebPart fechado de um catálogo de páginas de volta para uma página.
Movendo qualquer controle dentro de sua zona ou para outra zona.
Adicionando um controle de um catálogo de WebPart controles ou de servidor ou adicionando um controle programaticamente.
Criando uma conexão entre dois WebPart controles, programaticamente ou usando a interface do usuário de conexão.
Excluindo uma conexão entre dois WebPart controles, programaticamente ou usando a interface do usuário de conexão.
Para acessar esse valor de propriedade, você deve converter a WebPartManager instância de controle na IPersonalizable interface; em seguida, você pode ler o valor da IsDirty propriedade.