LayoutEditorPart Класс

Определение

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

Наследование

Object

Control

WebControl

Panel

Part

EditorPart

LayoutEditorPart

Примеры

В следующем примере кода показано, как объявить LayoutEditorPart элемент управления на веб-странице и включить его изменение нескольких свойств пользовательского WebPart интерфейса элемента управления. Пример кода состоит из трех частей:

• Пользовательский элемент управления, позволяющий изменять режимы отображения на странице веб-частей.

• Веб-страница, содержащая EditorZone элемент управления и LayoutEditorPart элемент управления, который используется для изменения свойств макета BulletedList элемента управления.

• Описание работы примера при загрузке страницы в браузере.

Первая часть этого примера кода — это пользовательский элемент управления, позволяющий пользователям изменять режимы отображения на веб-странице. Дополнительные сведения о режимах отображения и описании исходного кода в этом элементе управления см. в пошаговом руководстве. Изменение режимов отображения на странице веб-частей.

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

Второй частью примера кода является веб-страница. Он содержит декларативную ссылку на EditorZone элемент управления с дочерним <zonetemplate> элементом, содержащим декларативные ссылки на LayoutEditorPart элемент управления. Обратите внимание, что страница также содержит BulletedList элемент управления, привязанный к базе данных Pubs, так как этот элемент управления находится в зоне, он работает как WebPartZoneWebPart элемент управления, который может быть изменен элементом LayoutEditorPart управления.

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

При загрузке страницы в браузере можно выбрать режим редактирования в раскрывающемся списке " Режим отображения ", чтобы переключиться в режим редактирования. Вы можете щелкнуть меню команд (стрелка вниз) в строке заголовка элемента управления "Веб-часть списка авторов " и нажать кнопку "Изменить", чтобы начать редактирование . Когда пользовательский интерфейс редактирования отображается, вы увидите LayoutEditorPart элемент управления и кнопку и текстовое поле, расположенные над ним. Если в пользовательском интерфейсе редактирования внесены некоторые изменения и нажмите кнопку "Применить ", вы можете использовать раскрывающийся список " Режим отображения ", чтобы вернуть страницу для просмотра и увидеть полный эффект изменений редактирования.

Комментарии

Класс LayoutEditorPart является элементом управления редактором, производным от EditorPart класса, и используется для редактирования свойств, влияющих на макет связанного WebPart или GenericWebPart элемента управления.

Так же, как и в наборе элементов управления веб-частей (подробные сведения см ToolZone . обзор класса), существуют элементы управления с инструментом (части инструментов), а каждая часть инструмента должна находиться в определенном типе зоны инструментов. Части инструментов в наборе элементов управления веб-частей имеют две отличительные характеристики:

• Они являются вспомогательными элементами управления, которые позволяют конечным пользователям персонализировать элементы управления на странице веб-частей.

• Они видны только в определенных режимах отображения.

Элемент LayoutEditorPart управления — это часть средства, которая становится видимой только в том случае, если страница веб-частей находится в режиме редактирования, а также когда для редактирования выбран определенный WebPart элемент управления. Элемент LayoutEditorPart управления, как и все остальные EditorPart элементы управления, находится в элементе EditorZone управления.

Класс LayoutEditorPart имеет Title свойство, которое получает или задает заголовок для элемента управления макетом. Класс также имеет Display свойство, которое переопределяет базовое свойство и возвращает true. Это означает, что LayoutEditorPart элемент управления всегда отображается, когда страница находится в режиме редактирования, даже если AllowEditWebPart свойство редактируемого элемента управления имеет значение false. Другими словами, пользователи всегда могут изменять свойства в элементе LayoutEditorPart управления, даже если указанный WebPart элемент управления не может быть изменен другими EditorPart элементами управления.

Класс LayoutEditorPart также имеет два важных метода, ApplyChanges и SyncChangesкоторый он наследует от EditorPart класса и переопределяет. Методы являются критически важными, так как они позволяют получать и задавать значения свойств между значениями полей элемента управления редактора и свойствами WebPart редактируемого элемента управления.

В большинстве случаев элемент управления должен использоваться в формате сохраняемости страниц, объявляя <asp:layouteditorpart> элемент внутри <zonetemplate> элемента, который, в свою очередь, LayoutEditorPart содержится <asp:editorzone> элементом на веб-странице. Элемент LayoutEditorPart управления позволяет конечным пользователям изменять следующие свойства пользовательского WebPart интерфейса элемента управления:

• ChromeState

• Zone

• ZoneIndex

Чтобы изменить другие свойства и поведение WebPart элементов управления, можно использовать другие EditorPart элементы управления, предоставленные набором элементов управления веб-частей. К этим элементам управления относятся BehaviorEditorPart, а AppearanceEditorPartтакже PropertyGridEditorPart элемент управления. Предоставленные EditorPart элементы управления должны предоставлять большинство функций редактирования, необходимых для редактирования WebPart элементов управления, но можно также создать пользовательский элемент управления редактора, наследуя от EditorPart класса. Пример кода см. в обзоре EditorPart класса.

Доступность

Разметка, отображаемая по умолчанию для этого элемента управления, может не соответствовать стандартам специальных возможностей, таким как рекомендации по специальным возможностям веб-содержимого 1.0 (WCAG) приоритет 1. Дополнительные сведения о поддержке специальных возможностей для этого элемента управления см. в ASP.NET элементах управления и специальных возможностях.

См. также раздел

• AppearanceEditorPart
• BehaviorEditorPart
• PropertyGridEditorPart
• элементы управления веб-частей ASP.NET