LayoutEditorPart Classe

Definição

public ref class LayoutEditorPart sealed : System::Web::UI::WebControls::WebParts::EditorPart

public sealed class LayoutEditorPart : System.Web.UI.WebControls.WebParts.EditorPart

type LayoutEditorPart = class
    inherit EditorPart

Public NotInheritable Class LayoutEditorPart
Inherits EditorPart

Herança

Object

Control

WebControl

Panel

Part

EditorPart

LayoutEditorPart

Exemplos

O exemplo de código a seguir demonstra como declarar um LayoutEditorPart controle em uma página da Web e habilitá-lo para editar várias propriedades de interface do usuário de um WebPart controle. O exemplo de código tem três partes:

• Um controle de usuário que permite alterar os modos de exibição em uma página de Web Parts.

• Uma página da Web que contém um EditorZone controle e um LayoutEditorPart controle, que é usado para editar as propriedades de layout de um BulletedList controle.

• Uma explicação de como o exemplo funciona quando você carrega a página em um navegador.

A primeira parte desse exemplo de código é o controle de usuário que permite que os usuários alterem os modos de exibição em uma página da Web. Para obter detalhes sobre modos de exibição e uma descrição do código-fonte nesse controle, consulte Passo a passo: alterando modos de exibição em uma página de Web Parts.

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

A segunda parte do exemplo de código é a página da Web. Ele contém uma referência declarativa a um EditorZone controle, com um elemento filho <zonetemplate> que contém referências declarativas a um LayoutEditorPart controle. Observe que a página também contém um BulletedList controle associado ao banco de dados pubs; como esse controle reside em uma WebPartZone zona, ele funciona como um WebPart controle que pode ser editado pelo LayoutEditorPart controle.

<%@ Page Language="C#" %>
<%@ Register Src="~/displayModeMenuCS.ascx" 
  TagPrefix="uc1" 
  TagName="DisplayModeMenuCS" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  protected void Page_Load(object sender, EventArgs e)
  {
    Button1.Visible = false;
    TextBox1.Visible = false;
    BulletedList1.DataBind();
  }

  // <snippet3>
  protected void Button1_Click(object sender, EventArgs e)
  {
    LayoutEditorPart1.Title = Server.HtmlEncode(TextBox1.Text);
  }
  // </snippet3>

  // <snippet4>
  protected void  LayoutEditorPart1_PreRender(object sender, EventArgs e)
  {
    Button1.Visible = true;
    TextBox1.Visible = true;
  }
  // </snippet4>  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="form1" runat="server">
    <!-- This example uses Microsoft SQL Server and connects    -->
    <!-- to the Pubs sample database. Use an ASP.NET expression -->
    <!-- like the one in the following control to retrieve the  -->
    <!-- connection string value from the Web.config file.      -->
    <asp:SqlDataSource ID="ds1" runat="server" 
      connectionString="<%$ ConnectionStrings:PubsConnection %>" 
      SelectCommand="Select au_id, au_lname, au_fname From Authors"/>
    <asp:WebPartManager ID="WebPartManager1" runat="server" />
    <uc1:DisplayModeMenuCS id="menu1" runat="server" />
    <asp:WebPartZone ID="WebPartZone1" runat="server" Width="150" 
      style="z-index: 100; left: 10px; position: absolute; top: 90px" >
      <ZoneTemplate>
        <asp:Panel ID="panel1" runat="server" Title="Author List WebPart">
          <asp:Label ID="Label1" runat="server" 
            Text="Author Names" 
            Font-Bold="true" 
            Font-Size="120%"
            AssociatedControlID="BulletedList1"/>
          <asp:BulletedList ID="BulletedList1" runat="server" 
            DataSourceID="ds1" 
            DataTextField="au_lname" 
            DataValueField="au_id"/>
        </asp:Panel>
      </ZoneTemplate>
    </asp:WebPartZone>
    <asp:WebPartZone ID="WebPartZone2" runat="server" Width="150" 
      style="z-index: 101; left: 170px; position: absolute; top: 90px" />
    <asp:EditorZone ID="EditorZone1" runat="server" 
      style="z-index: 102; left: 340px; position: absolute; top: 90px" 
      Width="170px">
      <ZoneTemplate>
        <asp:LayoutEditorPart ID="LayoutEditorPart1" runat="server" 
          Title="My Layout Editor" OnPreRender="LayoutEditorPart1_PreRender" />
      </ZoneTemplate>
    </asp:EditorZone>
    <asp:Button ID="Button1" runat="server" Width="140" 
      Text="Update EditorPart Title" 
      style="left: 340px; position: absolute; top: 65px; z-index: 103;" 
      OnClick="Button1_Click" />
    <asp:TextBox ID="TextBox1" runat="server" 
      style="z-index: 105; left: 500px; position: absolute; top: 65px" />
  </form>
</body>
</html>

<%@ Page Language="VB" %>
<%@ Register Src="~/displayModeMenuVB.ascx" 
  TagPrefix="uc1" 
  TagName="DisplayModeMenuVB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
    Button1.Visible = False
    TextBox1.Visible = False
    BulletedList1.DataBind()
  End Sub

  ' <snippet3>
  Protected Sub Button1_Click(ByVal sender As Object, _
    ByVal e As System.EventArgs)
    LayoutEditorPart1.Title = Server.HtmlEncode(TextBox1.Text)
  End Sub
  ' </snippet3>

  ' <snippet4>
  Protected Sub LayoutEditorPart1_PreRender(ByVal sender As Object, _
    ByVal e As System.EventArgs)
   
    Button1.Visible = True
    TextBox1.Visible = True
    
  End Sub
  ' </snippet4>
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="form1" runat="server">
    <!-- This example uses Microsoft SQL Server and connects    -->
    <!-- to the Pubs sample database. Use an ASP.NET expression -->
    <!-- like the one in the following control to retrieve the  -->
    <!-- connection string value from the Web.config file.      -->
    <asp:SqlDataSource ID="ds1" runat="server" 
      connectionString="<%$ ConnectionStrings:PubsConnection %>" 
      SelectCommand="Select au_id, au_lname, au_fname From Authors"/>
    <asp:WebPartManager ID="WebPartManager1" runat="server" />
    <uc1:DisplayModeMenuVB id="menu1" runat="server" />
    <asp:WebPartZone ID="WebPartZone1" runat="server" Width="150" 
      style="z-index: 100; left: 10px; position: absolute; top: 90px" >
      <ZoneTemplate>
        <asp:Panel ID="panel1" runat="server" Title="Author List WebPart">
          <asp:Label ID="Label1" runat="server" 
            Text="Author Names" 
            Font-Bold="true" 
            Font-Size="120%"
            AssociatedControlID="BulletedList1"/>
          <asp:BulletedList ID="BulletedList1" runat="server" 
            DataSourceID="ds1" 
            DataTextField="au_lname" 
            DataValueField="au_id"/>
        </asp:Panel>
      </ZoneTemplate>
    </asp:WebPartZone>
    <asp:WebPartZone ID="WebPartZone2" runat="server" Width="150" 
      style="z-index: 101; left: 170px; position: absolute; top: 90px" />
    <asp:EditorZone ID="EditorZone1" runat="server" 
      style="z-index: 102; left: 340px; position: absolute; top: 90px" 
      Width="170px">
      <ZoneTemplate>
        <asp:LayoutEditorPart ID="LayoutEditorPart1" runat="server" 
          Title="My Layout Editor" 
          OnPreRender="LayoutEditorPart1_PreRender" />
      </ZoneTemplate>
    </asp:EditorZone>
    <asp:Button ID="Button1" runat="server" Width="140" 
      Text="Update EditorPart Title" 
      style="left: 340px; position: absolute; top: 65px; z-index: 103;" 
      OnClick="Button1_Click" />
    <asp:TextBox ID="TextBox1" runat="server" 
      style="z-index: 105; left: 500px; position: absolute; top: 65px" />
  </form>
</body>
</html>

Ao carregar a página em um navegador, você pode selecionar Editar Modo no controle de lista suspensa Modo de Exibição para alternar para o modo de edição. Você pode clicar no menu de verbos (a seta para baixo) na barra de título do controle WebPart Lista de Autor e clicar em Editar para começar a editar. Quando a interface do usuário de edição estiver visível, você poderá ver o LayoutEditorPart controle e um botão e uma caixa de texto posicionados acima dele. Se você fizer algumas alterações na interface do usuário de edição e clicar no botão Aplicar , poderá usar o controle de lista suspensa Modo de Exibição para retornar a página para o modo de navegação e ver o efeito completo das alterações de edição.

Comentários

A LayoutEditorPart classe é um controle de editor que deriva da EditorPart classe e é usado para editar propriedades que afetam o layout de um controle ou GenericWebPart associadoWebPart.

Assim como há zonas orientadas a ferramentas no conjunto de controle de Web Parts (para obter detalhes, consulte a visão geral da ToolZone classe), há controles de parte orientados a ferramentas (partes de ferramenta) e cada parte da ferramenta deve residir em um determinado tipo de zona de ferramenta. As partes de ferramentas no conjunto de controle de Web Parts têm duas características diferenciais:

• São controles auxiliares que permitem que os usuários finais personalizem controles em uma página de Web Parts.

• Eles são visíveis apenas em determinados modos de exibição.

O LayoutEditorPart controle é uma parte de ferramenta que fica visível somente quando uma página de Web Parts está no modo de edição e quando um controle específico WebPart é selecionado para edição. O LayoutEditorPart controle, como todos os outros EditorPart controles, reside em um EditorZone controle .

A LayoutEditorPart classe tem uma Title propriedade , que obtém ou define o título de um controle de layout. A classe também tem uma Display propriedade , que substitui a propriedade base e retorna true. Isso significa que o LayoutEditorPart controle sempre fica visível quando a página está no modo de edição, mesmo que a AllowEdit propriedade no WebPart controle que está sendo editado esteja definida como false. Em outras palavras, os usuários sempre podem editar as propriedades em um LayoutEditorPart controle, mesmo que um controle especificado WebPart não possa ser editado pelos outros EditorPart controles.

A LayoutEditorPart classe também tem dois métodos importantes, ApplyChanges e SyncChanges, que herda da EditorPart classe e substitui. Os métodos são críticos porque permitem obter e definir os valores de propriedade entre os valores de campo do controle do editor e as propriedades no WebPart controle que está sendo editado.

Na maioria dos casos, o LayoutEditorPart controle deve ser usado no formato de persistência de página declarando um <asp:layouteditorpart> elemento dentro de um <zonetemplate> elemento , que por sua vez está contido por um <asp:editorzone> elemento em uma página da Web. O LayoutEditorPart controle permite que os usuários finais editem as seguintes propriedades de interface do usuário de um WebPart controle:

• ChromeState

• Zone

• ZoneIndex

Para editar outras propriedades e comportamento de WebPart controles, você pode usar os outros EditorPart controles fornecidos com o conjunto de controle de Web Parts. Esses controles incluem o BehaviorEditorPart, o AppearanceEditorParte o PropertyGridEditorPart controle . Os controles fornecidos EditorPart devem fornecer a maioria dos recursos de edição necessários para editar WebPart controles, mas você também pode criar um controle de editor personalizado herdando da EditorPart classe . Para obter um exemplo de código, consulte a visão geral da EditorPart classe.

Acessibilidade

A marcação renderizada por padrão para esse controle pode não estar em conformidade com os padrões de acessibilidade, como as diretrizes de prioridade 1.0 (Diretrizes de Acessibilidade de Conteúdo da Web 1.0). Para obter detalhes sobre o suporte de acessibilidade para esse controle, consulte Controles de ASP.NET e Acessibilidade.

Construtores

Propriedades

Métodos

Eventos

Implantações explícitas de interface

Métodos de Extensão

Aplica-se a

Confira também

• AppearanceEditorPart
• BehaviorEditorPart
• PropertyGridEditorPart
• controles de Web Parts ASP.NET