ImportCatalogPart Klasse

Definition

public ref class ImportCatalogPart sealed : System::Web::UI::WebControls::WebParts::CatalogPart

public sealed class ImportCatalogPart : System.Web.UI.WebControls.WebParts.CatalogPart

type ImportCatalogPart = class
    inherit CatalogPart

Public NotInheritable Class ImportCatalogPart
Inherits CatalogPart

Vererbung

Object

Control

WebControl

Panel

Part

CatalogPart

ImportCatalogPart

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie das ImportCatalogPart Steuerelement deklarativ und programmgesteuert auf einer Webseite verwendet wird. Das Beispiel umfasst vier Teile:

• Ein Benutzersteuerelement, mit dem Sie die Anzeigemodi auf einer Webparts-Seite ändern können.

• Eine Webseite, die ein CatalogZone -Steuerelement und ein ImportCatalogPart -Steuerelement enthält.

• Eine Quellcodedatei, die zwei benutzerdefinierte WebPart Steuerelemente enthält.

• Eine Erläuterung, wie das Beispiel funktioniert, wenn Sie die Seite in einem Browser laden.

Der erste Teil dieses Codebeispiels ist das Benutzersteuerelement, mit dem Benutzer die Anzeigemodi auf einer Webseite ändern können. Sie sollten den folgenden Quellcode in einer Datei platzieren und ihr den Namen Displaymodemenucs.ascx oder Displaymodemenuvb.ascx geben (je nachdem, welche Sprache Sie verwenden). Ausführliche Informationen zu Anzeigemodi und eine Beschreibung des Quellcodes in diesem Steuerelement finden Sie unter Exemplarische Vorgehensweise: Ändern von Anzeigemodi auf einer Webparts-Seite.

<%@ control language="C#" classname="DisplayModeMenuCS"%>
<script runat="server">
  
 // Use a field to reference the current WebPartManager.
  WebPartManager _manager;

  void Page_Init(object sender, EventArgs e)
  {
    Page.InitComplete += new EventHandler(InitComplete);
    
  }  

  void InitComplete(object sender, System.EventArgs e)
  {
    _manager = WebPartManager.GetCurrentWebPartManager(Page);

    String browseModeName = WebPartManager.BrowseDisplayMode.Name;

    // Fill the dropdown with the names of supported display modes.
    foreach (WebPartDisplayMode mode in _manager.SupportedDisplayModes)
    {
      String modeName = mode.Name;
      // Make sure a mode is enabled before adding it.
      if (mode.IsEnabled(_manager))
      {
        ListItem item = new ListItem(modeName, modeName);
        DisplayModeDropdown.Items.Add(item);
      }
    }

    // If shared scope is allowed for this user, display the scope-switching
    // UI and select the appropriate radio button for the current user scope.
    if (_manager.Personalization.CanEnterSharedScope)
    {
      Panel2.Visible = true;
      if (_manager.Personalization.Scope == PersonalizationScope.User)
        RadioButton1.Checked = true;
      else
        RadioButton2.Checked = true;
    }
    
  }
 
  // Change the page to the selected display mode.
  void DisplayModeDropdown_SelectedIndexChanged(object sender, EventArgs e)
  {
    String selectedMode = DisplayModeDropdown.SelectedValue;

    WebPartDisplayMode mode = _manager.SupportedDisplayModes[selectedMode];
    if (mode != null)
      _manager.DisplayMode = mode;
  }

  // Set the selected item equal to the current display mode.
  void Page_PreRender(object sender, EventArgs e)
  {
    ListItemCollection items = DisplayModeDropdown.Items;
    int selectedIndex = 
      items.IndexOf(items.FindByText(_manager.DisplayMode.Name));
    DisplayModeDropdown.SelectedIndex = selectedIndex;
  }

  // Reset all of a user's personalization data for the page.
  protected void LinkButton1_Click(object sender, EventArgs e)
  {
    _manager.Personalization.ResetPersonalizationState();
  }

  // If not in User personalization scope, toggle into it.
  protected void RadioButton1_CheckedChanged(object sender, EventArgs e)
  {
    if (_manager.Personalization.Scope == PersonalizationScope.Shared)
      _manager.Personalization.ToggleScope();
  }

  // If not in Shared scope, and if user is allowed, toggle the scope.
  protected void RadioButton2_CheckedChanged(object sender, EventArgs e)
  {
    if (_manager.Personalization.CanEnterSharedScope && 
        _manager.Personalization.Scope == PersonalizationScope.User)
      _manager.Personalization.ToggleScope();
  }
</script>
<div>
  <asp:Panel ID="Panel1" runat="server" 
    Borderwidth="1" 
    Width="230" 
    BackColor="lightgray"
    Font-Names="Verdana, Arial, Sans Serif" >
    <asp:Label ID="Label1" runat="server" 
      Text="&nbsp;Display Mode" 
      Font-Bold="true"
      Font-Size="8"
      Width="120" 
      AssociatedControlID="DisplayModeDropdown"/>
    <asp:DropDownList ID="DisplayModeDropdown" runat="server"  
      AutoPostBack="true" 
      Width="120"
      OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
    <asp:LinkButton ID="LinkButton1" runat="server"
      Text="Reset User State" 
      ToolTip="Reset the current user's personalization data for the page."
      Font-Size="8" 
      OnClick="LinkButton1_Click" />
    <asp:Panel ID="Panel2" runat="server" 
      GroupingText="Personalization Scope"
      Font-Bold="true"
      Font-Size="8" 
      Visible="false" >
      <asp:RadioButton ID="RadioButton1" runat="server" 
        Text="User" 
        AutoPostBack="true"
        GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
      <asp:RadioButton ID="RadioButton2" runat="server" 
        Text="Shared" 
        AutoPostBack="true"
        GroupName="Scope" 
        OnCheckedChanged="RadioButton2_CheckedChanged" />
    </asp:Panel>
  </asp:Panel>
</div>

<%@ control language="vb" classname="DisplayModeMenuVB"%>
<script runat="server">
  ' Use a field to reference the current WebPartManager.
  Dim _manager As WebPartManager

  Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs)
    AddHandler Page.InitComplete, AddressOf InitComplete
  End Sub

  Sub InitComplete(ByVal sender As Object, ByVal e As System.EventArgs)
    _manager = WebPartManager.GetCurrentWebPartManager(Page)
      
    Dim browseModeName As String = WebPartManager.BrowseDisplayMode.Name
      
    ' Fill the dropdown with the names of supported display modes.
    Dim mode As WebPartDisplayMode
    For Each mode In _manager.SupportedDisplayModes
      Dim modeName As String = mode.Name
      ' Make sure a mode is enabled before adding it.
      If mode.IsEnabled(_manager) Then
        Dim item As New ListItem(modeName, modeName)
        DisplayModeDropdown.Items.Add(item)
      End If
    Next mode
      
    ' If shared scope is allowed for this user, display the scope-switching
    ' UI and select the appropriate radio button for the current user scope.
    If _manager.Personalization.CanEnterSharedScope Then
      Panel2.Visible = True
      If _manager.Personalization.Scope = PersonalizationScope.User Then
        RadioButton1.Checked = True
      Else
        RadioButton2.Checked = True
      End If
    End If
   
  End Sub

  ' Change the page to the selected display mode.
  Sub DisplayModeDropdown_SelectedIndexChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    Dim selectedMode As String = DisplayModeDropdown.SelectedValue   
    Dim mode As WebPartDisplayMode = _
      _manager.SupportedDisplayModes(selectedMode)
    If Not (mode Is Nothing) Then
      _manager.DisplayMode = mode
    End If

  End Sub
   
  ' Set the selected item equal to the current display mode.
  Sub Page_PreRender(ByVal sender As Object, ByVal e As EventArgs)
    Dim items As ListItemCollection = DisplayModeDropdown.Items
    Dim selectedIndex As Integer = _
      items.IndexOf(items.FindByText(_manager.DisplayMode.Name))
    DisplayModeDropdown.SelectedIndex = selectedIndex

  End Sub

  ' Reset all of a user's personalization data for the page.
  Protected Sub LinkButton1_Click(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    _manager.Personalization.ResetPersonalizationState()
    
  End Sub

  ' If not in User personalization scope, toggle into it.
  Protected Sub RadioButton1_CheckedChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    If _manager.Personalization.Scope = PersonalizationScope.Shared Then
      _manager.Personalization.ToggleScope()
    End If

  End Sub
   
  ' If not in Shared scope, and if user is allowed, toggle the scope.
  Protected Sub RadioButton2_CheckedChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    If _manager.Personalization.CanEnterSharedScope AndAlso _
      _manager.Personalization.Scope = PersonalizationScope.User Then
      _manager.Personalization.ToggleScope()
    End If

  End Sub

</script>
<div>
  <asp:Panel ID="Panel1" runat="server" 
    Borderwidth="1" 
    Width="230" 
    BackColor="lightgray"
    Font-Names="Verdana, Arial, Sans Serif" >
    <asp:Label ID="Label1" runat="server" 
      Text="&nbsp;Display Mode" 
      Font-Bold="true"
      Font-Size="8"
      Width="120" 
      AssociatedControlID="DisplayModeDropdown"/>
    <asp:DropDownList ID="DisplayModeDropdown" runat="server"  
      AutoPostBack="true" 
      Width="120"
      OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
    <asp:LinkButton ID="LinkButton1" runat="server"
      Text="Reset User State" 
      ToolTip="Reset the current user's personalization data for the page."
      Font-Size="8" 
      OnClick="LinkButton1_Click" />
    <asp:Panel ID="Panel2" runat="server" 
      GroupingText="Personalization Scope"
      Font-Bold="true"
      Font-Size="8" 
      Visible="false" >
      <asp:RadioButton ID="RadioButton1" runat="server" 
        Text="User" 
        AutoPostBack="true"
        GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
      <asp:RadioButton ID="RadioButton2" runat="server" 
        Text="Shared" 
        AutoPostBack="true"
        GroupName="Scope" 
        OnCheckedChanged="RadioButton2_CheckedChanged" />
    </asp:Panel>
  </asp:Panel>
</div>

Der zweite Teil des Codebeispiels ist die Webseite. Oben auf der Seite befinden sich zwei register Direktiven, eine für das Benutzersteuerelement und eine für die kompilierte Komponente, die die beiden benutzerdefinierten WebPart Steuerelemente enthält. Beachten Sie, dass die Seite einen deklarativen Verweis auf das Steuerelement enthält, der ImportCatalogPart in der richtigen Hierarchie deklarativer Elemente geschachtelt ist. Beachten Sie auch, dass dem Element mehrere Eigenschaftswerte deklarativ <asp:importcatalogpart> zugewiesen werden. Außerdem aktualisiert die Button1_Click -Methode eine Reihe von Eigenschaftswerten für das ImportCatalogPart Steuerelement.

Im -Steuerelement der Seite WebPartZone werden die beiden benutzerdefinierten WebPart Steuerelemente deklariert. Das <aspSample:userinfowebpart> Steuerelement verfügt über ein exportmode="all" -Attribut. Dieses Attribut ist erforderlich, damit Benutzer eine Beschreibungsdatei für das Steuerelement exportieren können, die dann von anderen Benutzern importiert werden kann, die das Steuerelement mithilfe der Beschreibungsdatei importieren möchten.

<%@ 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">

  // <snippet3>
  protected void Button1_Click(object sender, EventArgs e)
  {
    ImportCatalogPart1.Title = "Import Server Controls";
    ImportCatalogPart1.BrowseHelpText = "Enter the path to a "
      + "description file.";
    ImportCatalogPart1.UploadButtonText = "Upload Description";
    ImportCatalogPart1.UploadHelpText = "Upload a description file.";
    ImportCatalogPart1.ImportedPartLabelText = "Imported Controls";
    ImportCatalogPart1.PartImportErrorLabelText = "An error occurred " 
      + "during the import process.";

  }
  // </snippet3>
  
  protected void Page_Load(object sender, EventArgs e)
  {
    Button1.Visible = false;
  }

  protected void ImportCatalogPart1_PreRender(object sender, 
    EventArgs e)
  {
    Button1.Visible = true;
  }
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head id="Head1" runat="server">
    <title>
      ImportCatalogPart Control
    </title>
  </head>
  <body>
    <form id="form1" runat="server">
      <asp:webpartmanager id="WebPartManager1" runat="server"  />
      <uc1:DisplayModeMenuCS ID="DisplayModeMenu1" runat="server" />
      <asp:webpartzone id="zone1" runat="server" >
        <PartTitleStyle BorderWidth="1" 
          Font-Names="Verdana, Arial"
          Font-Size="110%"
          BackColor="LightBlue" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="TextDisplayWebPart1" 
            title = "Text Display WebPart" /> 
          <aspsample:userinfowebpart id="userinfo1" runat="server" 
            Title="User Information" exportmode="all" />
        </zonetemplate>
      </asp:webpartzone> 
      <asp:EditorZone ID="EditorZone1" runat="server">
        <ZoneTemplate>
          <asp:PropertyGridEditorPart ID="PropertyGridEditorPart1" 
            runat="server" />
        </ZoneTemplate>
      </asp:EditorZone>
      <asp:CatalogZone ID="CatalogZone1" runat="server">
        <ZoneTemplate>
          <asp:ImportCatalogPart ID="ImportCatalogPart1" 
            runat="server" 
            Title="My ImportCatalogPart" 
            OnPreRender="ImportCatalogPart1_PreRender"
            BrowseHelpText="Type a path or browse to find a control's 
              description file." 
            UploadButtonText="Upload Description File" 
            UploadHelpText="Click the button to upload the description 
              file."
            ImportedPartLabelText="My User Information WebPart" 
            PartImportErrorLabelText="An error occurred while trying 
              to import a description file."  />
        </ZoneTemplate>
      </asp:CatalogZone>
      <hr />
      <asp:Button ID="Button1" runat="server" 
        Text="Update ImportCatalogPart" 
        OnClick="Button1_Click" />
    </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">

  ' <snippet3>
  Protected Sub Button1_Click(ByVal sender As Object, _
    ByVal e As EventArgs)
      ImportCatalogPart1.Title = "Import Server Controls"
      ImportCatalogPart1.BrowseHelpText = "Enter the path to a " _
        & "description file."
      ImportCatalogPart1.UploadButtonText = "Upload Description"
      ImportCatalogPart1.UploadHelpText = "Upload a description file."
      ImportCatalogPart1.ImportedPartLabelText = "Imported Controls"
      ImportCatalogPart1.PartImportErrorLabelText = "An error occurred " _
        & "during the import process."
  End Sub
  ' </snippet3>

  Protected Sub Page_Load(ByVal sender As Object, _
    ByVal e As EventArgs)
      Button1.Visible = false
  End Sub

  Protected Sub ImportCatalogPart1_PreRender(ByVal sender As Object, _
    ByVal e As EventArgs)
      Button1.Visible = true
  End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>
      ImportCatalogPart Control
    </title>
  </head>
  <body>
    <form id="form1" runat="server">
      <asp:webpartmanager id="WebPartManager1" runat="server"  />
      <uc1:DisplayModeMenuVB ID="DisplayModeMenu1" runat="server" />
      <asp:webpartzone id="zone1" runat="server" >
        <PartTitleStyle BorderWidth="1" 
          Font-Names="Verdana, Arial"
          Font-Size="110%"
          BackColor="LightBlue" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="TextDisplayWebPart1" 
            title = "Text Display WebPart" /> 
          <aspsample:userinfowebpart id="userinfo1" runat="server" 
            Title="User Information" exportmode="all" />
        </zonetemplate>
      </asp:webpartzone> 
      <asp:EditorZone ID="EditorZone1" runat="server">
        <ZoneTemplate>
          <asp:PropertyGridEditorPart ID="PropertyGridEditorPart1" 
            runat="server" />
        </ZoneTemplate>
      </asp:EditorZone>
      <asp:CatalogZone ID="CatalogZone1" runat="server">
        <ZoneTemplate>
          <asp:ImportCatalogPart ID="ImportCatalogPart1" 
            runat="server" 
            Title="My ImportCatalogPart" 
            OnPreRender="ImportCatalogPart1_PreRender"
            BrowseHelpText="Type a path or browse to find a control's 
              description file." 
            UploadButtonText="Upload Description File" 
            UploadHelpText="Click the button to upload the description 
              file."
            ImportedPartLabelText="My User Information WebPart" 
            PartImportErrorLabelText="An error occurred while trying 
              to import a description file."  />
        </ZoneTemplate>
      </asp:CatalogZone>
      <hr />
      <asp:Button ID="Button1" runat="server" 
        Text="Update ImportCatalogPart" 
        OnClick="Button1_Click" />
    </form>
  </body>
</html>

Der dritte Teil des Codebeispiels ist der Quellcode für die beiden WebPart Steuerelemente. Beachten Sie, dass einige Eigenschaften für diese Steuerelemente mit dem WebBrowsable -Attribut gekennzeichnet sind. Dadurch kann das PropertyGridEditorPart Steuerelement dynamisch die Benutzeroberfläche (UI) generieren, damit ein Benutzer diese Eigenschaften bearbeiten kann, wenn sich die Steuerelemente im Bearbeitungsmodus befinden. Die Eigenschaften werden auch mit einem WebDisplayName -Attribut gekennzeichnet, um den Text der Bezeichnung anzugeben, die neben jedem Steuerelement auf der Bearbeitungsoberfläche angezeigt wird. Damit das Codebeispiel ausgeführt werden kann, müssen Sie diesen Quellcode kompilieren. Sie können sie explizit kompilieren und die resultierende Assembly im Ordner Bin ihrer Website oder im globalen Assemblycache ablegen. Alternativ können Sie den Quellcode im Ordner App_Code Ihrer Website ablegen, wo er zur Laufzeit dynamisch kompiliert wird. In diesem Codebeispiel wird die dynamische Kompilierung verwendet. Eine exemplarische Vorgehensweise, die beide Kompilierungsmethoden veranschaulicht, finden Sie unter Exemplarische Vorgehensweise: Entwickeln und Verwenden eines benutzerdefinierten Webserversteuerelements.

Auf das benutzerdefinierte Steuerelement namens TextDisplayWebPart wird auf der Webseite mit einem <aspSample:TextDisplayWebPart> -Element verwiesen. Das andere Steuerelement mit dem Namen UserInfoWebPartwird zunächst ebenfalls auf der Webseite deklariert. Sie entfernen es jedoch später, um die Möglichkeit zum Importieren einer Beschreibungsdatei für ein Steuerelement zu veranschaulichen.

using System;
using System.Collections;
using System.ComponentModel;
using System.Drawing;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
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 UserInfoWebPart : WebPart
  {
    HttpServerUtility server = HttpContext.Current.Server;
    private String _userNickName = "Add a nickname.";
    private String _userPetName = "Add a pet name.";
    private DateTime _userSpecialDate = DateTime.Now;
    private Boolean _userIsCurrent = true;
    private JobTypeName _userJobType = JobTypeName.Unselected;
    public enum JobTypeName
    {
      Unselected = 0,
      Support = 1,
      Service = 2,
      Professional = 3, 
      Technical = 4,
      Manager = 5,
      Executive = 6
    }
    Label NickNameLabel;
    Label PetNickNameLabel;
    Label SpecialDateLabel;
    CheckBox IsCurrentCheckBox;
    Label JobTypeLabel;

    // Add the Personalizable and WebBrowsable attributes to the  
    // public properties, so that users can save property values  
    // and edit them with a PropertyGridEditorPart control.
    [Personalizable(), WebBrowsable, WebDisplayName("Nickname")]
    public String NickName
    {
      get 
      { 
        object o = ViewState["NickName"];
        if (o != null)
          return (string)o;
        else
          return _userNickName;        
      } 

      set { _userNickName = server.HtmlEncode(value); }
    }

    [Personalizable(), WebBrowsable, WebDisplayName("Pet Name")]
    public String PetName
    {
      get 
      { 
        object o = ViewState["PetName"];
        if (o != null)
          return (string)o;
        else
          return _userPetName;        
      }

      set { _userPetName = server.HtmlEncode(value); }
    }

    [Personalizable(), WebBrowsable(), WebDisplayName("Special Day")]
    public DateTime SpecialDay
    {
      get
      {
        object o = ViewState["SpecialDay"];
        if (o != null)
          return (DateTime)o;
        else
          return _userSpecialDate;
      }

      set { _userSpecialDate = value; }
    }

    [Personalizable(), WebBrowsable(), WebDisplayName("Job Type")]
    public JobTypeName UserJobType
    {
      get
      {
        object o = ViewState["UserJobType"];
        if (o != null)
          return (JobTypeName)o;
        else
          return _userJobType;
      }

      set { _userJobType = (JobTypeName)value; }
    }

    [Personalizable(), WebBrowsable(), WebDisplayName("Is Current")]
    public Boolean IsCurrent
    {
      get
      {
        object o = ViewState["IsCurrent"];
        if (o != null)
          return (Boolean)o;
        else
          return _userIsCurrent;
      }

      set { _userIsCurrent = value; }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();

      NickNameLabel = new Label();
      NickNameLabel.Text = this.NickName;
      SetControlAttributes(NickNameLabel);

      PetNickNameLabel = new Label();
      PetNickNameLabel.Text = this.PetName;
      SetControlAttributes(PetNickNameLabel);

      SpecialDateLabel = new Label();
      SpecialDateLabel.Text = this.SpecialDay.ToShortDateString();
      SetControlAttributes(SpecialDateLabel);

      IsCurrentCheckBox = new CheckBox();
      IsCurrentCheckBox.Checked = this.IsCurrent;
      SetControlAttributes(IsCurrentCheckBox);

      JobTypeLabel = new Label();
      JobTypeLabel.Text = this.UserJobType.ToString();
      SetControlAttributes(JobTypeLabel);

      ChildControlsCreated = true;
    }

    private void SetControlAttributes(WebControl ctl)
    {
      ctl.BackColor = Color.White;
      ctl.BorderWidth = 1;
      ctl.Width = 200;
      this.Controls.Add(ctl);
    }

    protected override void RenderContents(HtmlTextWriter writer)
    {
      writer.Write("Nickname:");
      writer.WriteBreak();
      NickNameLabel.RenderControl(writer);
      writer.WriteBreak();
      writer.Write("Pet Name:");
      writer.WriteBreak();
      PetNickNameLabel.RenderControl(writer);
      writer.WriteBreak();
      writer.Write("Special Date:");
      writer.WriteBreak();
      SpecialDateLabel.RenderControl(writer);
      writer.WriteBreak();
      writer.Write("Job Type:");
      writer.WriteBreak();
      JobTypeLabel.RenderControl(writer);
      writer.WriteBreak();
      writer.Write("Current:");
      writer.WriteBreak();
      IsCurrentCheckBox.RenderControl(writer);
    }
  }

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

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

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      DisplayContent.BackColor = Color.LightBlue;
      DisplayContent.Text = this.ContentText;
      this.Controls.Add(DisplayContent);

      lineBreak = new Literal();
      lineBreak.Text = @"<br />";
      Controls.Add(lineBreak);

      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);
    }

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

Imports System.Collections
Imports System.ComponentModel
Imports System.Drawing
Imports System.Security.Permissions
Imports System.Web
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 Class UserInfoWebPart
    Inherits WebPart
    Private server As HttpServerUtility = HttpContext.Current.Server
    Private _userNickName As String = "Add a nickname."
    Private _userPetName As String = "Add a pet name."
    Private _userSpecialDate As DateTime = DateTime.Now
    Private _userIsCurrent As [Boolean] = True
    Private _userJobType As JobTypeName = JobTypeName.Unselected

    Public Enum JobTypeName
      Unselected = 0
      Support = 1
      Service = 2
      Professional = 3
      Technical = 4
      Manager = 5
      Executive = 6
    End Enum

    Private NickNameLabel As Label
    Private PetNickNameLabel As Label
    Private SpecialDateLabel As Label
    Private IsCurrentCheckBox As CheckBox
    Private JobTypeLabel As Label

    ' Add the Personalizable and WebBrowsable attributes to the  
    ' public properties, so that users can save property values  
    ' and edit them with a PropertyGridEditorPart control.

    <Personalizable(), WebBrowsable(), WebDisplayName("Nickname")> _
    Public Property NickName() As String
      Get
        Dim o As Object = ViewState("NickName")
        If Not (o Is Nothing) Then
          Return CStr(o)
        Else
          Return _userNickName
        End If
      End Get
      Set(ByVal value As String)
        _userNickName = server.HtmlEncode(value)
      End Set
    End Property

    <Personalizable(), WebBrowsable(), WebDisplayName("Pet Name")> _
    Public Property PetName() As String
      Get
        Dim o As Object = ViewState("PetName")
        If Not (o Is Nothing) Then
          Return CStr(o)
        Else
          Return _userPetName
        End If
      End Get
      Set(ByVal value As String)
        _userPetName = server.HtmlEncode(value)
      End Set
    End Property

    <Personalizable(), WebBrowsable(), WebDisplayName("Special Day")> _
    Public Property SpecialDay() As DateTime
      Get
        Dim o As Object = ViewState("SpecialDay")
        If Not (o Is Nothing) Then
          Return CType(o, DateTime)
        Else
          Return _userSpecialDate
        End If
      End Get

      Set(ByVal value As DateTime)
        _userSpecialDate = value
      End Set
    End Property

    <Personalizable(), WebBrowsable(), WebDisplayName("Job Type")> _
    Public Property UserJobType() As JobTypeName
      Get
        Dim o As Object = ViewState("UserJobType")
        If Not (o Is Nothing) Then
          Return CType(o, JobTypeName)
        Else
          Return _userJobType
        End If
      End Get
      Set(ByVal value As JobTypeName)
        _userJobType = CType(value, JobTypeName)
      End Set
    End Property

    <Personalizable(), WebBrowsable(), WebDisplayName("Is Current")> _
    Public Property IsCurrent() As [Boolean]
      Get
        Dim o As Object = ViewState("IsCurrent")
        If Not (o Is Nothing) Then
          Return CType(o, [Boolean])
        Else
          Return _userIsCurrent
        End If
      End Get
      Set(ByVal value As [Boolean])
        _userIsCurrent = value
      End Set
    End Property

    Protected Overrides Sub CreateChildControls()
      Controls.Clear()

      NickNameLabel = New Label()
      NickNameLabel.Text = Me.NickName
      SetControlAttributes(NickNameLabel)

      PetNickNameLabel = New Label()
      PetNickNameLabel.Text = Me.PetName
      SetControlAttributes(PetNickNameLabel)

      SpecialDateLabel = New Label()
      SpecialDateLabel.Text = Me.SpecialDay.ToShortDateString()
      SetControlAttributes(SpecialDateLabel)

      IsCurrentCheckBox = New CheckBox()
      IsCurrentCheckBox.Checked = Me.IsCurrent
      SetControlAttributes(IsCurrentCheckBox)

      JobTypeLabel = New Label()
      JobTypeLabel.Text = Me.UserJobType.ToString()
      SetControlAttributes(JobTypeLabel)

      ChildControlsCreated = True

    End Sub

    Private Sub SetControlAttributes(ByVal ctl As WebControl)
      ctl.BackColor = Color.White
      ctl.BorderWidth = 1
      ctl.Width = 200
      Me.Controls.Add(ctl)
    End Sub

    Protected Overrides Sub RenderContents(ByVal writer As HtmlTextWriter)
      writer.Write("Nickname:")
      writer.WriteBreak()
      NickNameLabel.RenderControl(writer)
      writer.WriteBreak()
      writer.Write("Pet Name:")
      writer.WriteBreak()
      PetNickNameLabel.RenderControl(writer)
      writer.WriteBreak()
      writer.Write("Special Date:")
      writer.WriteBreak()
      SpecialDateLabel.RenderControl(writer)
      writer.WriteBreak()
      writer.Write("Job Type:")
      writer.WriteBreak()
      JobTypeLabel.RenderControl(writer)
      writer.WriteBreak()
      writer.Write("Current:")
      writer.WriteBreak()
      IsCurrentCheckBox.RenderControl(writer)

    End Sub

  End Class


  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class TextDisplayWebPart
    Inherits WebPart
    Private _contentText As String = Nothing
    Private _fontStyle As String = Nothing
    Private input As TextBox
    Private DisplayContent As Label
    Private lineBreak As Literal

    <Personalizable(), WebBrowsable()> _
    Public Property ContentText() As String
      Get
        Return _contentText
      End Get
      Set(ByVal value As String)
        _contentText = value
      End Set
    End Property

    Protected Overrides Sub CreateChildControls()
      Controls.Clear()
      DisplayContent = New Label()
      DisplayContent.BackColor = Color.LightBlue
      DisplayContent.Text = Me.ContentText
      Me.Controls.Add(DisplayContent)

      lineBreak = New Literal()
      lineBreak.Text = "<br />"
      Controls.Add(lineBreak)

      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)

    End Sub

    Private Sub submit_Click(ByVal sender As Object, _
                             ByVal e As EventArgs)
      ' Update the label string.
      If String.IsNullOrEmpty(input.Text) = False Then
        _contentText = Context.Server.HtmlEncode(input.Text) + "<br />"
        input.Text = String.Empty
        DisplayContent.Text = Me.ContentText
      End If

    End Sub

  End Class

End Namespace

Führen Sie nun das Codebeispiel aus. Laden Sie die Webseite in einen Browser. Der erste Schritt besteht darin, das UserInfoWebPart Steuerelement zu bearbeiten. Verwenden Sie das Dropdownlistensteuerelement Anzeigemodus , und wählen Sie Bearbeiten aus, um die Seite in den Bearbeitungsmodus zu wechseln. Klicken Sie auf das Verbenmenü des UserInfoWebPart Steuerelements (den Pfeil nach unten in der Titelleiste), und klicken Sie dann auf Bearbeiten. Wenn die Bearbeitungsbenutzeroberfläche angezeigt wird, werden unter dem UserInfoWebPart Steuerelement mehrere Bearbeitungssteuerelemente angezeigt, die Sie zum Bearbeiten der Feldwerte verwenden können. Bearbeiten Sie einige Felder, klicken Sie auf OK, und verwenden Sie dann die Dropdownliste Anzeigemodus , um die Seite in den Browsermodus zurückzugeben.

Der zweite Schritt besteht darin, eine zu exportieren. WebPart-Beschreibungsdatei für das UserInfoWebPart Steuerelement. Klicken Sie auf das Menü Verben im benutzerdefinierten Steuerelement (dargestellt durch den Pfeil nach unten in der Titelleiste), und klicken Sie auf Exportieren. Befolgen Sie die Anweisungen zum Speichern von . WebPart-Beschreibungsdatei für das Steuerelement. Schließen Sie nun die Webseite, und bearbeiten Sie die Seitenquelle in einem Editor. Löschen Sie das <aspSample:userinfowebpart> Steuerelementdeklarationselement, speichern und schließen Sie die Datei. (Sie führen diesen Schritt aus, um einen Benutzer zu simulieren, der noch nicht über das UserInfoWebPart Steuerelement verfügt, damit Sie das Steuerelement auf die Seite importieren können.)

Laden Sie die Webseite erneut in einem Browser. Das UserInfoWebPart Steuerelement sollte nicht angezeigt werden, da Sie es entfernt haben. Verwenden Sie das Dropdownlistensteuerelement Anzeigemodus , und wählen Sie Katalog aus, um die Seite in den Katalogmodus zu wechseln. Klicken Sie im ImportCatalogPart Steuerelement auf die Schaltfläche Durchsuchen , und navigieren Sie zu . WebPart-Datei, die Sie erstellt haben, und klicken Sie dann auf die Schaltfläche Hochladen . Ein Verweis auf das Steuerelement sollte mit einem Kontrollkästchen daneben angezeigt werden. Aktivieren Sie das Kontrollkästchen, und klicken Sie dann auf Hinzufügen , um das Steuerelement der Seite hinzuzufügen.

Während Sie sich in dieser Ansicht der Seite befinden, klicken Sie unten auf der Seite auf die Schaltfläche ImportCatalogPart aktualisieren , um die Auswirkungen der programmgesteuerten Aktualisierung einer Reihe von Eigenschaftswerten für das ImportCatalogPart Steuerelement anzuzeigen. Nachdem Sie auf die Schaltfläche geklickt haben, beobachten Sie, wie die verschiedenen Eigenschaften in der Benutzeroberfläche geändert werden.

Klicken Sie abschließend auf Schließen , um den Katalogmodus zu beenden und die Seite in den Browsermodus zurückzugeben. Das UserInfoWebPart Steuerelement sollte nun auf der Seite angezeigt werden und die Werte enthalten, die es beim früheren Export hatte.

Hinweise

Mit ImportCatalogPart dem -Steuerelement können Benutzer eine Beschreibungsdatei importieren, die Einstellungen für ein Steuerelement oder Serversteuerelement WebPart beschreibt, die ein Benutzer einer WebPartZoneBase Zone hinzufügen möchte.

Nachdem ein Benutzer eine Beschreibungsdatei importiert hat, wird das WebPart Steuerelement, auf das in der Datei verwiesen wird, innerhalb des ImportCatalogPart Steuerelements angezeigt, und ein Benutzer kann das Steuerelement der Seite hinzufügen.

Die Beschreibungsdatei ist nicht identisch mit dem Steuerelement selbst. Es handelt sich um eine XML-Datei, die mit einer endet. WebPart-Erweiterung und enthält Name-Wert-Paare (hauptsächlich Eigenschaftswerte), die den Zustand des Steuerelements beschreiben. Die Beschreibungsdatei wird gemäß einem angegebenen XML-Format erstellt, wie im Thema Webparts-Steuerelementbeschreibungsdateien beschrieben.

Das Steuerelement, auf das sich die Beschreibungsdatei bezieht, kann entweder in eine Assembly kompiliert werden, oder es kann ein Benutzersteuerelement sein, das in einer ASCX-Datei definiert ist. In beiden Fällen muss das Steuerelement, auf das in einer importierten Beschreibungsdatei verwiesen wird, auf dem Webserver vorhanden sein, der die Seite hostet, die versucht, das Steuerelement zu importieren. Die Beschreibungsdatei verweist auf den Namen des Steuerelements und die Assembly (oder Datei), die das Steuerelement enthält, und die Beschreibungsdatei enthält Einstellungen, die sich auf die Eigenschaftswerte, das Aussehen und das Verhalten des Steuerelements auswirken.

Mit ImportCatalogPart dem -Steuerelement können Benutzer Einstellungen für Steuerelemente freigeben. Ein komplexes Steuerelement kann über viele Eigenschaften und Einstellungen verfügen. In einer typischen Intranetwebsite in einem großen Unternehmen kann ein benutzerdefiniertes WebPart Steuerelement beispielsweise eine Reihe von Eigenschaften enthalten, die spezifische Werte für die Umgebung des Benutzers enthalten, z. B. Datenbankverbindungen, Abteilungsinformationen usw. Das Steuerelement kann auch eine Reihe von Eigenschaften enthalten, die sich auf seine Darstellung auswirken. Ein Benutzer könnte das Steuerelement auf einer bestimmten Website personalisieren und ordnungsgemäß funktionieren lassen, eine Beschreibungsdatei für das Steuerelement exportieren und dann die Beschreibungsdatei für andere Benutzer freigeben, die die Datei importieren könnten, um das vollständig konfigurierte Steuerelement anderen Intranetwebsites hinzuzufügen, die sie personalisieren dürfen. Solange die kompilierte Assembly- oder Benutzersteuerelementdatei, die das Steuerelement enthält, auf dem Webserver vorhanden ist, der ihre Website hostet, können Benutzer das Steuerelement anderen Websites hinzufügen.

Der Mechanismus, mit dem Benutzer eine Beschreibungsdatei (und damit das zugehörige Serversteuerelement) in eine Webseite importieren, ist das ImportCatalogPart Steuerelement, das ein Seitenentwickler einer Webseite hinzufügen muss. Wenn ein Benutzer die Seite in den Kataloganzeigemodus wechselt, wird das ImportCatalogPart Steuerelement angezeigt, und der Benutzer kann dieses Steuerelement verwenden, um zum zu navigieren. WebPart-Beschreibungsdatei, die dem zu importierenden Serversteuerelement entspricht. Gemäß der Benutzeroberfläche und den Anweisungen des ImportCatalogPart Steuerelements kann ein Benutzer das gewünschte Serversteuerelement der Webseite hinzufügen, wobei sein Aussehen und die Eigenschaften vollständig konfiguriert sind, wie in der importierten Beschreibungsdatei angegeben.

Bevor die Beschreibungsdatei eines WebPart Steuerelements importiert werden kann, muss ein Benutzer zuerst die Datei basierend auf einem vorhandenen WebPart Steuerelement erstellen (exportieren). Eine Beschreibungsdatei kann für ein Steuerelement exportiert werden, wenn die folgenden Bedingungen erfüllt sind:

• Das Steuerelement verfügt über Eigenschaften, die mit dem Personalizable -Attribut gekennzeichnet sind.

• Für die Web.config-Datei ist der enableExport Attributwert für das <webParts> -Element auf true festgelegt.

• Ein Entwickler legt den Wert der ExportMode -Eigenschaft für das Steuerelement auf einen anderen Wert als den Standardwert von Nonefest, der den Export verhindert. Wenn der ExportMode Eigenschaftswert auf NonSensitiveDatafestgelegt ist, wird jede Eigenschaft, die einen IsSensitive Parameter mit einem Personalizable Attribut enthält, nicht exportiert, wenn ein Benutzer eine Beschreibungsdatei exportiert. Dadurch können Steuerungsentwickler in bestimmten Situationen verhindern, dass vertrauliche Daten, z. B. Verbindungszeichenfolgen, exportiert werden.

Ein Benutzer kann ein Steuerelement exportieren, das für den Export aktiviert wurde, indem er auf das Exportverb klicken, das im Verbenmenü des Steuerelements angezeigt wird, und die Anweisungen zum Speichern von befolgen. WebPart-Beschreibungsdatei für das Steuerelement. Andere Benutzer können diese Datei dann importieren, um ihre eigenen Instanzen des Steuerelements zu konfigurieren.

Die ImportCatalogPart -Klasse enthält mehrere Eigenschaften. Die BrowseHelpText -Eigenschaft enthält Text mit Anweisungen für Benutzer, wenn sie nach der Beschreibungsdatei suchen. Die ImportedPartLabelText -Eigenschaft enthält Text, der als Bezeichnung für das importierte Steuerelement dient, wie es im ImportCatalogPart Steuerelement angezeigt wird. Enthält PartImportErrorLabelText Text, der angezeigt wird, wenn beim Importieren einer Steuerelementbeschreibung ein Fehler auftritt. Die Title -Eigenschaft überschreibt die Basiseigenschaft, um einem Steuerelement einen Standardtitel ImportCatalogPart zuzuweisen, wenn der Entwickler keinen Titel zuweist. Die UploadButtonText -Eigenschaft enthält den Text für die Schaltfläche, auf die der Benutzer klickt, um die Beschreibungsdatei hochzuladen, und die UploadHelpText -Eigenschaft enthält die Anweisungen für den Uploadprozess.

Die ImportCatalogPart -Klasse enthält auch mehrere eindeutige Methoden. Die GetAvailableWebPartDescriptions -Methode ruft ein WebPartDescription -Objekt für jedes WebPart Steuerelement im Katalog ab, wodurch ein ImportCatalogPart Steuerelement Informationen zu jedem Serversteuerelement anzeigen kann, ohne eine Instanz davon erstellen zu müssen. Die GetWebPart -Methode ruft eine Instanz eines bestimmten WebPart Steuerelements basierend auf der an die -Methode übergebenen Beschreibung ab.

Es gibt einige inhärente Risiken, die mit der Verwendung des Steuerelements ImportCatalogPart verbunden sind. Ein Beispiel ist die Möglichkeit, böswillige Daten über die für den Import verwendeten Beschreibungsdateien in Ihre Webanwendung zu importieren. Wenn jemand schädlichen Skriptcode als Wert einer Zeichenfolgeneigenschaft in der Beschreibungsdatei platziert hat, kann dieses Skript möglicherweise ausgeführt werden, wenn ein Benutzer die Beschreibungsdatei importiert und das Serversteuerelement, auf das verwiesen wird, einer Webseite hinzufügt. Um das Risiko des Importierens von Beschreibungsdateien mit schädlichen Daten zu minimieren, sollten Serversteuerelemente, die Zeichenfolgeneigenschaften aufweisen, die Eigenschaftendaten immer codieren. Ein weiteres Risiko besteht im Importieren von Typen über Beschreibungsdateien (siehe Webparts Control Description Files). Ein böswilliger Benutzer kann Anforderungen zum Laden vieler Assemblys in senden AppDomain, was zu einer übermäßigen Arbeitsspeicherauslastung führt.

Um die mit dem Import verbundenen Risiken zu vermeiden, können Sie das Feature vollständig deaktivieren, indem Sie das Importfeature oder das ImportCatalogPart Steuerelement nicht verwenden. Sie können auch einschränken, welche Benutzer Zugriff auf das Steuerelement haben. Sie könnten dies programmgesteuert mithilfe der Rollenverwaltung tun (siehe Verwalten der Autorisierung mithilfe von Rollen). Wenn die Seite beispielsweise geladen wird, können Sie testen, ob ein Benutzer einer bestimmten Rolle angehört, z. B. der Administratorrolle. Wenn der Benutzer in der Rolle ist, können Sie das ImportCatalogPart Steuerelement programmgesteuert der Seite für diesen Benutzer hinzufügen. Sie können auch einen deklarativen Ansatz verwenden, um die Anzahl von Benutzern einzuschränken, die das ImportCatalogPart Steuerelement verwenden können. Innerhalb Ihrer Webseite, die einen Katalog enthält, können Sie zwei CatalogZone Steuerelemente platzieren: eines für Benutzer, die importieren können, und eines für diejenigen, die dies nicht können. Die Zone für Benutzer, die importieren können, würde das ImportCatalogPart -Steuerelement enthalten. Die Zone selbst kann innerhalb eines LoginView Steuerelements platziert werden, wodurch Sie die Verwendung des Steuerelements in der Zone auf die von Ihnen angegebenen authentifizierten Benutzer oder Rollen beschränken können.

Konstruktoren

Eigenschaften

Methoden

Ereignisse

Explizite Schnittstellenimplementierungen

Erweiterungsmethoden

Gilt für:

Weitere Informationen

• PageCatalogPart
• DeclarativeCatalogPart
• Webparts-Steuerelementbeschreibungsdateien
• ASP.NET Webparts-Steuerelemente