ImportCatalogPart Classe

Définition

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

Héritage

Object

Control

WebControl

Panel

Part

CatalogPart

ImportCatalogPart

Exemples

L’exemple de code suivant montre comment utiliser le ImportCatalogPart contrôle de manière déclarative et programmatique sur une page web. L’exemple comporte quatre parties :

• Contrôle utilisateur qui vous permet de modifier les modes d’affichage d’une page de composants WebPart.

• Page web qui contient un CatalogZone contrôle et un ImportCatalogPart contrôle.

• Fichier de code source qui contient deux contrôles personnalisés WebPart .

• Explication du fonctionnement de l’exemple lorsque vous chargez la page dans un navigateur.

La première partie de cet exemple de code est le contrôle utilisateur qui permet aux utilisateurs de modifier les modes d’affichage sur une page Web. Vous devez placer le code source suivant dans un fichier et le nommer Displaymodemenucs.ascx ou Displaymodemenuvb.ascx (selon la langue que vous utilisez). Pour plus d’informations sur les modes d’affichage et une description du code source dans ce contrôle, consultez Procédure pas à pas : modification des modes d’affichage sur une page de composants WebPart.

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

La deuxième partie de l’exemple de code est la page Web. En haut de la page se trouvent deux register directives, l’une pour le contrôle utilisateur et l’autre pour le composant compilé qui contient les deux contrôles personnalisés WebPart . Notez que la page a une référence déclarative au ImportCatalogPart contrôle, imbriquée dans la hiérarchie appropriée d’éléments déclaratifs. Notez également que plusieurs valeurs de propriété sont attribuées de manière déclarative sur l’élément <asp:importcatalogpart> . En outre, la Button1_Click méthode met à jour un certain nombre de valeurs de propriété sur le ImportCatalogPart contrôle.

Dans le contrôle de WebPartZone la page, les deux contrôles personnalisés WebPart sont déclarés. Le <aspSample:userinfowebpart> contrôle a un exportmode="all" attribut. Cet attribut est requis pour permettre aux utilisateurs d’exporter un fichier de description pour le contrôle, qui peut ensuite être importé par d’autres utilisateurs qui souhaitent importer le contrôle à l’aide du fichier de description.

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

La troisième partie de l’exemple de code est le code source des deux WebPart contrôles. Notez que certaines propriétés de ces contrôles sont marquées avec l’attribut WebBrowsable . Cela permet au PropertyGridEditorPart contrôle de générer dynamiquement l’interface utilisateur pour qu’un utilisateur modifie ces propriétés lorsque les contrôles sont en mode édition. Les propriétés sont également marquées avec un WebDisplayName attribut, pour spécifier le texte de l’étiquette qui apparaît en regard de chaque contrôle dans l’interface utilisateur de modification. Pour que l’exemple de code s’exécute, vous devez compiler ce code source. Vous pouvez le compiler explicitement et placer l’assembly résultant dans le dossier Bin de votre site web ou dans le global assembly cache. Vous pouvez également placer le code source dans le dossier App_Code de votre site, où il sera compilé dynamiquement au moment de l’exécution. Cet exemple de code utilise la compilation dynamique. Pour obtenir une procédure pas à pas qui illustre les deux méthodes de compilation, consultez Procédure pas à pas : développement et utilisation d’un contrôle de serveur web personnalisé.

Le contrôle personnalisé appelé TextDisplayWebPart est référencé dans la page web avec un <aspSample:TextDisplayWebPart> élément. L’autre contrôle, appelé UserInfoWebPart, est également déclaré sur la page Web initialement, même si vous le supprimerez ultérieurement pour illustrer la possibilité d’importer un fichier de description pour un contrôle.

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

Exécutez maintenant l’exemple de code. Chargez la page Web dans un navigateur. La première étape consiste à modifier le UserInfoWebPart contrôle. Utilisez le contrôle de liste déroulante Mode d’affichage et sélectionnez Modifier pour basculer la page en mode édition. Cliquez sur le menu verbes du UserInfoWebPart contrôle (flèche vers le bas dans la barre de titre), puis cliquez sur Modifier. Lorsque l’interface utilisateur de modification s’affiche, plusieurs contrôles de modification apparaissent sous le UserInfoWebPart contrôle que vous pouvez utiliser pour modifier ses valeurs de champ. Modifiez certains champs, cliquez sur OK, puis utilisez la liste déroulante Mode d’affichage pour renvoyer le mode de navigation de la page.

La deuxième étape consiste à exporter un . Fichier de description WebPart pour le UserInfoWebPart contrôle. Cliquez sur le menu verbes du contrôle personnalisé (représenté par la flèche vers le bas dans la barre de titre), puis cliquez sur Exporter. Suivez les instructions pour enregistrer un . Fichier de description WebPart pour le contrôle. Fermez maintenant la page Web, puis modifiez la source de la page dans un éditeur. Supprimez l’élément <aspSample:userinfowebpart> de déclaration de contrôle, puis enregistrez et fermez le fichier. (Vous effectuez cette étape pour simuler un utilisateur qui n’a pas encore le UserInfoWebPart contrôle, afin de pouvoir importer le contrôle dans la page).

Chargez à nouveau la page web dans un navigateur. Le UserInfoWebPart contrôle ne doit pas apparaître, car vous l’avez supprimé. Utilisez le contrôle de liste déroulante Mode d’affichage et sélectionnez Catalogue pour basculer la page en mode catalogue. Dans le ImportCatalogPart contrôle, cliquez sur le bouton Parcourir , puis accédez à . Fichier WebPart que vous avez créé, puis cliquez sur le bouton Charger . Une référence au contrôle doit apparaître avec une case à cocher en regard de celui-ci. Activez la case à cocher, puis cliquez sur Ajouter pour ajouter le contrôle à la page.

Lorsque vous êtes dans cette vue de la page, cliquez sur le bouton Mettre à jour ImportCatalogPart en bas de la page pour voir l’effet de la mise à jour programmatique d’un certain nombre de valeurs de propriété sur le ImportCatalogPart contrôle. Après avoir cliqué sur le bouton, observez comment les différentes propriétés sont modifiées dans l’interface utilisateur.

Enfin, cliquez sur Fermer pour quitter le mode catalogue et retourner la page en mode de navigation. Le UserInfoWebPart contrôle doit maintenant apparaître dans la page, contenant les valeurs qu’il avait lorsque vous l’avez exporté précédemment.

Remarques

Le ImportCatalogPart contrôle permet aux utilisateurs d’importer un fichier de description qui décrit les paramètres d’un contrôle ou d’un WebPart contrôle serveur qu’un utilisateur souhaite ajouter à une WebPartZoneBase zone.

Une fois qu’un utilisateur a importé un fichier de description, le WebPart contrôle référencé dans le fichier s’affiche dans le ImportCatalogPart contrôle et un utilisateur peut ajouter le contrôle à la page.

Le fichier de description n’est pas identique au contrôle lui-même. Il s’agit d’un fichier XML qui se termine par . Extension WebPart et contient des paires nom/valeur, principalement des valeurs de propriété, qui décrivent l’état du contrôle. Le fichier de description est créé selon un format XML spécifié, comme décrit dans la rubrique Fichiers de description du contrôle des composants WebPart.

Quant au contrôle auquel le fichier de description fait référence, il peut être compilé dans un assembly ou il peut s’agir d’un contrôle utilisateur défini dans un fichier .ascx. Dans les deux cas, le contrôle référencé dans un fichier de description importé doit exister sur le serveur Web qui héberge la page qui tente d’importer le contrôle. Le fichier de description fait référence au nom du contrôle et à l’assembly (ou fichier) qui contient le contrôle, et le fichier de description contient des paramètres qui affectent les valeurs de propriété, l’apparence et le comportement du contrôle.

Le ImportCatalogPart contrôle permet aux utilisateurs de partager des paramètres sur les contrôles. Un contrôle complexe peut avoir de nombreuses propriétés et paramètres. Par exemple, dans un site intranet classique au sein d’une grande entreprise, un contrôle personnalisé WebPart peut contenir un certain nombre de propriétés qui contiennent des valeurs spécifiques à l’environnement des utilisateurs, telles que leurs connexions à la base de données, les informations du service, etc. Le contrôle peut également contenir un certain nombre de propriétés qui affectent son apparence. Un utilisateur peut personnaliser le contrôle sur un site particulier et le faire fonctionner correctement, exporter un fichier de description pour le contrôle, puis partager le fichier de description avec d’autres utilisateurs, qui peuvent importer le fichier pour ajouter le contrôle entièrement configuré sur d’autres sites intranet qu’ils sont autorisés à personnaliser. Tant que l’assembly compilé ou le fichier de contrôle utilisateur contenant le contrôle existe sur le serveur Web qui héberge leur site, les utilisateurs peuvent ajouter le contrôle à d’autres sites Web.

Le mécanisme par lequel les utilisateurs importent un fichier de description (et donc son contrôle serveur associé) dans une page Web est le ImportCatalogPart contrôle, qu’un développeur de pages doit ajouter à une page Web. Lorsqu’un utilisateur bascule la page en mode d’affichage catalogue, le ImportCatalogPart contrôle s’affiche et l’utilisateur peut utiliser ce contrôle pour accéder à . Fichier de description WebPart correspondant au contrôle serveur qu’il souhaite importer. En suivant l’interface utilisateur et les instructions fournies par le ImportCatalogPart contrôle, un utilisateur peut ajouter le contrôle serveur souhaité à la page Web, avec son apparence et ses propriétés entièrement configurées comme spécifié dans le fichier de description importé.

Avant d’importer le fichier de description d’un WebPart contrôle, un utilisateur doit d’abord créer (exporter) le fichier en fonction d’un contrôle existant WebPart . Un fichier de description peut être exporté pour un contrôle si les conditions suivantes sont remplies :

• Le contrôle a des propriétés marquées avec l’attribut Personalizable .

• La valeur d’attribut du enableExport fichier Web.config est définie true sur sur l’élément <webParts> .

• Un développeur définit la valeur de la ExportMode propriété sur le contrôle sur une valeur autre que la valeur par défaut de None, ce qui interdit l’exportation. Si la valeur de la ExportMode propriété est définie sur NonSensitiveData, toute propriété qui contient un IsSensitive paramètre avec un Personalizable attribut n’est pas exportée lorsqu’un utilisateur exporte un fichier de description. Cela permet aux développeurs de contrôle d’empêcher l’exportation de données sensibles, telles que les chaînes de connexion, dans certaines situations.

Un utilisateur peut exporter un contrôle qui a été activé pour l’exportation en cliquant sur le verbe d’exportation qui apparaît dans le menu verbes du contrôle, puis en suivant les instructions d’enregistrement d’un . Fichier de description WebPart pour le contrôle. D’autres utilisateurs peuvent ensuite importer ce fichier pour configurer leurs propres instances du contrôle.

La ImportCatalogPart classe contient plusieurs propriétés. La BrowseHelpText propriété contient du texte avec des instructions pour les utilisateurs lorsqu’ils recherchent le fichier de description. La ImportedPartLabelText propriété contient du texte qui sert d’étiquette pour le contrôle importé tel qu’il apparaît dans le ImportCatalogPart contrôle. contient le PartImportErrorLabelText texte affiché si une erreur se produit lors de l’importation d’une description de contrôle. La Title propriété remplace la propriété de base pour attribuer un titre par défaut à un ImportCatalogPart contrôle si le développeur n’attribue pas de titre. La UploadButtonText propriété contient le texte du bouton sur lequel l’utilisateur clique pour charger le fichier de description, et la UploadHelpText propriété contient les instructions pour le processus de chargement.

La ImportCatalogPart classe contient également plusieurs méthodes uniques. La GetAvailableWebPartDescriptions méthode récupère un WebPartDescription objet pour chaque WebPart contrôle du catalogue, ce qui permet à un contrôle d’afficher ImportCatalogPart des informations sur chaque contrôle serveur sans avoir à en créer une instance. La GetWebPart méthode obtient une instance d’un contrôle particulier WebPart , en fonction de la description passée à la méthode.

L’utilisation du ImportCatalogPart contrôle comporte certains risques inhérents. Par exemple, il est possible d’importer des données malveillantes dans votre application web via les fichiers de description utilisés pour l’importation. Si quelqu’un a placé du code de script malveillant comme valeur d’une propriété de chaîne dans le fichier de description, ce script peut potentiellement être exécuté lorsqu’un utilisateur importe le fichier de description et ajoute le contrôle serveur référencé à une page Web. Pour réduire le risque d’importation de fichiers de description avec des données malveillantes, les contrôles serveur qui ont des propriétés de type chaîne doivent toujours encoder les données de propriété. Un autre risque consiste à importer des types par le biais de fichiers de description (consultez Fichiers de description de contrôle des composants WebPart). Un utilisateur malveillant peut envoyer des demandes de chargement de nombreux assemblys dans le AppDomain, ce qui entraîne une consommation excessive de mémoire.

Pour éviter les risques associés à l’importation, vous pouvez désactiver complètement la fonctionnalité en n’utilisant pas la fonctionnalité d’importation ou le ImportCatalogPart contrôle. Vous pouvez également limiter les utilisateurs qui ont accès au contrôle. Vous pouvez le faire par programmation, à l’aide de la gestion des rôles (consultez Gestion des autorisations à l’aide de rôles). Par exemple, lorsque la page se charge, vous pouvez tester si un utilisateur est dans un rôle spécifique, tel que le rôle administrateur. Si l’utilisateur est dans le rôle, vous pouvez ajouter le ImportCatalogPart contrôle par programmation à la page de cet utilisateur. Vous pouvez également utiliser une approche déclarative pour limiter l’ensemble d’utilisateurs qui peuvent utiliser le ImportCatalogPart contrôle. Dans votre page web qui contient un catalogue, vous pouvez placer deux CatalogZone contrôles : l’un pour les utilisateurs qui peuvent importer et l’autre pour ceux qui ne le peuvent pas. La zone pour les utilisateurs qui peuvent importer contiendrait le ImportCatalogPart contrôle. La zone elle-même peut être placée à l’intérieur d’un LoginView contrôle, ce qui vous permettrait de limiter l’utilisation du contrôle dans la zone uniquement aux utilisateurs ou rôles authentifiés que vous spécifiez.

Constructeurs

Propriétés

Méthodes

Événements

Implémentations d’interfaces explicites

Méthodes d’extension

S’applique à

Voir aussi

• PageCatalogPart
• DeclarativeCatalogPart
• Fichiers de description du contrôle des composants WebPart
• contrôles de composants WebPart ASP.NET