Auf Englisch lesen

Freigeben über


IPersonalizable Schnittstelle

Definition

Definiert zusätzliche Verwaltungsfunktionen zum Anwenden und Extrahieren des Personalisierungszustands.

public interface IPersonalizable
Abgeleitet

Beispiele

Im folgenden Codebeispiel wird die Verwendung der IPersonalizable Schnittstelle veranschaulicht. Das Beispiel besteht aus einer ASPX-Seite, die auf ein Webpartsteuerelement namens UrlListWebPartverweist. Der folgende Code ist die ASPX-Datei für das Beispiel.

<%@ Page Language="C#"  %>
<%@ Register TagPrefix="dict" 
    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">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>IPersonalizable</title>
</head>
<body>
    <form id="form1" runat="server">
    <asp:WebPartManager ID="mgr" runat="server" />
    <div>
    <asp:WebPartZone ID="WebPartZone1" runat="server">
      <ZoneTemplate>
        <dict:urllistwebpart id="listwp1" runat="server"
          title="URL List WebPart" />
      </ZoneTemplate>
    </asp:WebPartZone>
    </div>
    </form>
</body>
</html>

Der folgende Code ist die Quelle für das benutzerdefinierte WebPart Steuerelement. Diese Datei sollte im Verzeichnis App_Code abgelegt werden.

namespace Samples.AspNet.CS.Controls
{

    using System;
    using System.Collections;
    using System.ComponentModel;
    using System.Diagnostics;
    using System.Drawing;
    using System.Web;
    using System.Web.UI;
    using System.Security.Permissions;
    using System.Web.UI.WebControls;
    using System.Web.UI.WebControls.WebParts;

    [AspNetHostingPermission(SecurityAction.Demand,
      Level = AspNetHostingPermissionLevel.Minimal)]
    [AspNetHostingPermission(SecurityAction.InheritanceDemand,
      Level = AspNetHostingPermissionLevel.Minimal)]
    public class UrlListWebPart : WebPart, IPersonalizable
    {
        private ArrayList _sharedUrls;
        private ArrayList _userUrls;
        private bool _listDirty;

        private TextBox _nameTextBox;
        private TextBox _urlTextBox;
        private Button _addButton;
        private BulletedList _list;

        protected override void CreateChildControls()
        {
            Label nameLabel = new Label();
            Label urlLabel = new Label();
            LiteralControl breakLiteral1 = new LiteralControl("<br />");
            LiteralControl breakLiteral2 = new LiteralControl("<br />");
            LiteralControl breakLiteral3 = new LiteralControl("<br />");

            _nameTextBox = new TextBox();
            _urlTextBox = new TextBox();
            _addButton = new Button();
            _list = new BulletedList();

            nameLabel.Text = "Name: ";
            urlLabel.Text = "URL: ";
            _nameTextBox.ID = "nameTextBox";
            _urlTextBox.ID = "urlTextBox";
            _addButton.Text = "Add";
            _addButton.ID = "addButton";
            _addButton.Click += new EventHandler(this.OnClickAddButton);
            _list.DisplayMode = BulletedListDisplayMode.HyperLink;
            _list.ID = "list";

            Controls.Add(nameLabel);
            Controls.Add(_nameTextBox);
            Controls.Add(breakLiteral1);

            Controls.Add(urlLabel);
            Controls.Add(_urlTextBox);
            Controls.Add(breakLiteral2);

            Controls.Add(_addButton);
            Controls.Add(breakLiteral3);

            Controls.Add(_list);
        }

        private void OnClickAddButton(object sender, EventArgs e)
        {
            string name = _nameTextBox.Text.Trim();
            string url = _urlTextBox.Text.Trim();

            Pair p = new Pair(name, url);
            if (WebPartManager.Personalization.Scope == PersonalizationScope.Shared)
            {
                _sharedUrls ??= new ArrayList();
                _sharedUrls.Add(p);
            }
            else
            {
                _userUrls ??= new ArrayList();
                _userUrls.Add(p);
            }

            OnUrlAdded();
        }

        protected virtual void OnUrlAdded()
        {
            _listDirty = true;
            ChildControlsCreated = false;
        }

        protected override void RenderContents(HtmlTextWriter writer)
        {
            if (_sharedUrls != null)
            {
                foreach (Pair p in _sharedUrls)
                {
                    _list.Items.Add(new ListItem((string)p.First, (string)p.Second));
                }
            }
            if (_userUrls != null)
            {
                foreach (Pair p in _userUrls)
                {
                    _list.Items.Add(new ListItem((string)p.First, (string)p.Second));
                }
            }

            base.RenderContents(writer);
        }

        public virtual bool IsDirty
        {
            get
            {
                return _listDirty;
            }
        }
        public new virtual void Load(PersonalizationDictionary state)
        {
            if (state != null)
            {
                PersonalizationEntry sharedUrlsEntry = state["sharedUrls"];
                if (sharedUrlsEntry != null)
                {
                    _sharedUrls = (ArrayList)sharedUrlsEntry.Value;
                }

                PersonalizationEntry userUrlsEntry = state["userUrls"];
                if (userUrlsEntry != null)
                {
                    _userUrls = (ArrayList)userUrlsEntry.Value;
                }
            }
        }

        public virtual void Save(PersonalizationDictionary state)
        {
            if ((_sharedUrls != null) && (_sharedUrls.Count != 0))
            {
                state["sharedUrls"] = new PersonalizationEntry(_sharedUrls, PersonalizationScope.Shared);
            }
            if ((_userUrls != null) && (_userUrls.Count != 0))
            {
                state["userUrls"] = new PersonalizationEntry(_userUrls, PersonalizationScope.User);
            }
        }
    }
}

Laden Sie die Seite in einen Browser. Geben Sie einen Namen ein, der eine URL darstellt, fügen Sie dann eine tatsächliche URL ab http://hinzu, und klicken Sie auf die Schaltfläche Hinzufügen , um die URL hinzuzufügen.

Hinweise

Zusätzlich zur Verwendung des Personalizable Attributs für Steuerelementeigenschaften kann ein Steuerelement auch zusätzliche Verwaltungsfunktionen für die Anwendung und Extraktion des Personalisierungszustands implementieren IPersonalizable . Beispielsweise sollten Steuerelemente, die private Zustandsinformationen verwalten müssen, diese Schnittstelle implementieren. Auch Steuerelemente, die über komplexe Mechanismen auf personalisierte Daten zugreifen, z. B. benutzerdefinierte Cachelösungen, Datenpersistenz auf Mainframes oder XML-Webdienste, sollten diese Schnittstelle implementieren.

Wichtig

Sie sollten keine Typen hinzufügen, die auf klassen basieren, die im verzeichnis App_Code definiert sind und dann vom standardmäßigen binären Serialisierungsmechanismus abhängig sind. App_Code-basierte Artefakte sind nicht konsistent binär serialisierbar, da ihre Assemblynamen zu zufälligen Zeitpunkten geändert werden können.

Eigenschaften

IsDirty

Ruft einen Wert ab, der angibt, ob die benutzerdefinierten Daten, die ein Steuerelement verwaltet, geändert wurden.

Methoden

Load(PersonalizationDictionary)

Lädt benutzerdefinierte Daten in ein Steuerelement.

Save(PersonalizationDictionary)

Speichert benutzerdefinierte Eigenschaften und interne Zustandsinformationen im PersonalizationDictionary-Objekt des Steuerelements.

Gilt für:

Produkt Versionen
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1