WebPartDisplayModeCollection Classe

Definição

Espaço de Nomes:: System.Web.UI.WebControls.WebParts

Assemblagem:: System.Web.dll

Importante

Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.

Contém uma coleção de WebPartDisplayMode objetos. Esta classe não pode ser herdada.

public ref class WebPartDisplayModeCollection sealed : System::Collections::CollectionBase

public sealed class WebPartDisplayModeCollection : System.Collections.CollectionBase

type WebPartDisplayModeCollection = class
    inherit CollectionBase

Public NotInheritable Class WebPartDisplayModeCollection
Inherits CollectionBase

Herança: Object

CollectionBase
WebPartDisplayModeCollection

Exemplos

O exemplo de código seguinte demonstra trabalhar com a WebPartDisplayModeCollection classe. O ponto chave é que tens de herdar da WebPartManager classe e sobrescrever o CreateDisplayModes método para adicionar um objeto personalizado WebPartDisplayMode à WebPartDisplayModeCollection coleção criada pelo WebPartManager controlo.

Este exemplo de código tem cinco partes:

Um controlo de utilizador que permite alterar modos de visualização numa página de Web Parts.
Uma página web que aloja os outros controlos.
Um controlo de utilizador que reside numa WebPartZone zona da página Web e permite introduzir e mostrar texto numa etiqueta.
Um ficheiro de código-fonte que contém dois controlos. Um é um controlo personalizado WebPartManager ; o outro é um objeto personalizado WebPartDisplayMode para adicionar aos modos de exibição padrão da página.
Uma explicação de como funciona o exemplo.

O código-fonte da primeira parte do exemplo do código, o controlo do utilizador que permite alterar os modos de visualização, vem de outro tópico. Para que este exemplo de código funcione, precisa de obter o ficheiro .ascx para o controlo do utilizador a partir do tópico Walkthrough: Changing Display Modes on a Web Parts Page , e colocar o ficheiro na mesma pasta da página .aspx neste exemplo de código.

A segunda parte do exemplo é a página Web. Contém dois WebPartZone controlos, ambos controlos de utilizador e o controlo personalizado WebPartManager . Note as Register diretivas no topo da página para referenciar os controlos do utilizador e o espaço de nomes para os controlos compilados.

<%@ Page Language="C#" %>
<%@ Register Src="TextDisplaycs.ascx" 
    TagName="TextDisplay" 
    TagPrefix="uc2" %>
<%@ Register Src="DisplayModeMenuCS.ascx" 
    TagName="DisplayModeMenuCS" 
    TagPrefix="uc1" %>
<%@ Register Namespace="Samples.AspNet.CS.Controls" 
    TagPrefix="sample" 
    Assembly="CustomDisplayModeCS"  %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <uc1:DisplayModeMenuCS id="menu1" runat="server" />
    <div>
    <sample:NewWebPartManager runat="server" ID="wpgm1" />
    <br />
    <table style="width: 100%">
      <tr valign="top" align="center" >
        <td style="width: 100px; height: 123px">
          <asp:WebPartZone ID="WebPartZone1" runat="server">
            <ZoneTemplate>
              <uc2:TextDisplay ID="TextDisplay1" runat="server" />
            </ZoneTemplate>
          </asp:WebPartZone>
        </td>
        <td style="width: 100px; height: 123px">
          <asp:WebPartZone ID="WebPartZone2" runat="server" />
        </td>
      </tr>
    </table>
    <br />
    </div>
    </form>
</body>
</html>

<%@ Page Language="vb" %>
<%@ Register Src="TextDisplayvb.ascx" 
    TagName="TextDisplay" 
    TagPrefix="uc2" %>
<%@ Register Src="DisplayModeMenuVB.ascx" 
    TagName="DisplayModeMenuVB" 
    TagPrefix="uc1" %>
<%@ Register Namespace="Samples.AspNet.VB.Controls" 
    TagPrefix="sample" 
    Assembly="CustomDisplayModeVB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <uc1:DisplayModeMenuVB id="menu1" runat="server" />
    <div>
    <sample:NewWebPartManager runat="server" ID="wpgm1" />
    <br />
    <table style="width: 100%">
      <tr valign="top" align="center" >
        <td style="width: 100px; height: 123px">
          <asp:WebPartZone ID="WebPartZone1" runat="server">
            <ZoneTemplate>
              <uc2:TextDisplay ID="TextDisplay1" runat="server" />
            </ZoneTemplate>
          </asp:WebPartZone>
        </td>
        <td style="width: 100px; height: 123px">
          <asp:WebPartZone ID="WebPartZone2" runat="server" />
        </td>
      </tr>
    </table>
    <br />
    </div>
    </form>
</body>
</html>

A terceira parte do exemplo é o controlo do utilizador para introduzir e mostrar texto. Note que utiliza um MultiView controlo para criar múltiplas vistas da interface do utilizador (UI). Uma vista é apresentada com o botão, a outra sem. Note que no método sobrescrito OnPreRender , o código verifica se a página está atualmente no modo de visualização personalizada e, se sim, mostra a primeira vista do controlo do utilizador, que inclui o botão. Se a página não estiver no modo de visualização personalizada (por exemplo, se a página estiver em modo de navegação ou design), o botão fica oculto.

Importante

Este exemplo tem uma caixa de texto que aceita a entrada do utilizador, o que constitui uma potencial ameaça à segurança. Por defeito, as páginas Web do ASP.NET validam que a entrada do utilizador não inclui elementos de script ou HTML. Para mais informações, consulte Visão Geral dos Exploits de Scripts.

<%@ Control Language="C#" %>
<%@ Import Namespace="Samples.AspNet.CS.Controls" %>
    
<script runat="server">
  private string textContent;

  [Personalizable]
  public string TextContent
  {
    get { return textContent; }
    set { textContent = value; }
  }

  protected override void OnPreRender(EventArgs e)
  {
    Label1.Text = this.textContent;
    int viewIndex = 0;

    WebPartManager wpmg = 
      WebPartManager.GetCurrentWebPartManager(this.Page);
    NewWebPartManager myNewWpmg = wpmg as NewWebPartManager;
    if (myNewWpmg != null)
    {
      WebPartDisplayMode mode = 
        myNewWpmg.SupportedDisplayModes[myNewWpmg.InLineEditDisplayMode.Name];
      if (mode != null && myNewWpmg.DisplayMode == mode)
      {
        viewIndex = 1;
      }
    }
    this.MultiView1.ActiveViewIndex = viewIndex;

  }

  protected void Button1_Click(object sender, EventArgs e)
  {
    this.TextContent = TextBox1.Text;

    WebPartManager wpmg = 
      WebPartManager.GetCurrentWebPartManager(this.Page);
    WebPartDisplayMode mode = 
      wpmg.SupportedDisplayModes[WebPartManager.BrowseDisplayMode.Name];
    if (mode != null)
      wpmg.DisplayMode = mode;
  }
  
</script>
<asp:MultiView ID="MultiView1" runat="server">
    <asp:View ID="View1" runat="server">
        <asp:Label ID="Label1" runat="server" Text="Label" />
    </asp:View>
    <asp:View ID="View2" runat="server">
        <asp:TextBox ID="TextBox1" runat="server"></asp:TextBox>
        <asp:Button ID="Button1" OnClick="Button1_Click" 
          runat="server" Text="Button" />
    </asp:View>
</asp:MultiView>

<%@ Control Language="vb" %>
<%@ Import Namespace="Samples.AspNet.VB.Controls" %>
    
<script runat="server">

  Private _textContent As String

  <Personalizable()> _
  Public Property TextContent() As String
    Get
      Return _textContent
    End Get
    Set(ByVal value As String)
      _textContent = Value
    End Set
  End Property
 
  Protected Overrides Sub OnPreRender(ByVal e As EventArgs)
    Label1.Text = Me.TextContent
    Dim viewIndex As Integer = 0
      
    Dim wpmg As WebPartManager = _
      WebPartManager.GetCurrentWebPartManager(Me.Page)
    Dim myNewWpmg As NewWebPartManager = _
      CType(wpmg, NewWebPartManager)
    If Not (myNewWpmg Is Nothing) Then
      Dim mode As WebPartDisplayMode = _
        myNewWpmg.SupportedDisplayModes(myNewWpmg.InLineEditDisplayMode.Name)
      If Not (mode Is Nothing) AndAlso _
        myNewWpmg.DisplayMode Is mode Then
        viewIndex = 1
      End If
    End If
    Me.MultiView1.ActiveViewIndex = viewIndex

  End Sub

  Protected Sub Button1_Click(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    Me.TextContent = TextBox1.Text
    Dim wpmg As WebPartManager = _
      WebPartManager.GetCurrentWebPartManager(Me.Page)
    Dim mode As WebPartDisplayMode = _
      wpmg.SupportedDisplayModes(WebPartManager.BrowseDisplayMode.Name)
    If Not (mode Is Nothing) Then
      wpmg.DisplayMode = mode
    End If

  End Sub
  
</script>
<asp:MultiView ID="MultiView1" runat="server">
    <asp:View ID="View1" runat="server">
        <asp:Label ID="Label1" runat="server" Text="Label" />
    </asp:View>
    <asp:View ID="View2" runat="server">
        <asp:TextBox ID="TextBox1" runat="server"></asp:TextBox>
        <asp:Button ID="Button1" OnClick="Button1_Click" 
          runat="server" Text="Button" />
    </asp:View>
</asp:MultiView>

A quarta parte do exemplo é o ficheiro fonte das duas classes personalizadas. Repare que a classe personalizada WebPartManager sobrepõe o CreateDisplayModes método, chama o método base para adicionar todos os modos de exibição predefinidos e depois adiciona o modo de visualização personalizado. A classe do modo de visualização personalizada, InLineEditDisplayMode, simplesmente herda de WebPartDisplayMode, define o nome do modo de visualização no construtor e sobrepõe várias propriedades base para estabelecer as características do ecrã personalizado.

Para que o exemplo de código seja executado, tens de compilar este código-fonte. Pode compilar explicitamente e colocar o assembly resultante na pasta Bin do seu site ou na cache global assembly. Alternativamente, pode colocar o código-fonte na pasta App_Code do seu site, onde será compilado dinamicamente em tempo de execução. Para um guia que demonstra como compilar, consulte Guia: Desenvolvimento e Utilização de um Controlo de Servidor Web Personalizado.

using System;
using System.Collections.Generic;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Security.Permissions;
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 NewWebPartManager : WebPartManager 
  {
    private static readonly WebPartDisplayMode _inLineEditDisplayMode =
      new InlineWebPartEditDisplayMode();

    public NewWebPartManager() {}

    protected override WebPartDisplayModeCollection CreateDisplayModes() 
    {
      WebPartDisplayModeCollection displayModes = 
        base.CreateDisplayModes();
      displayModes.Add(_inLineEditDisplayMode);
      return displayModes;
    }

    public WebPartDisplayMode InLineEditDisplayMode
    {
      get { return _inLineEditDisplayMode; }
    }

    private sealed class InlineWebPartEditDisplayMode : WebPartDisplayMode
    {
      public InlineWebPartEditDisplayMode()
        : base("Inline Edit Display")
      {
      }
      public override bool AllowPageDesign
      {
        get { return true; }
      }
      public override bool RequiresPersonalization
      {
        get { return true; }
      }
      public override bool ShowHiddenWebParts
      {
        get { return false; }
      }
      public override bool AssociatedWithToolZone
      {
        get { return false; }
      }
      public override bool IsEnabled(WebPartManager webPartManager)
      {
        return true;
      }
    }
  }
}

Imports System.Collections.Generic
Imports System.Configuration
Imports System.Web
Imports System.Web.Security
Imports System.Security.Permissions
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 NewWebPartManager
    Inherits WebPartManager
    Private Shared _inLineEditDisplayMode As WebPartDisplayMode = _
      New InlineWebPartEditDisplayMode()

    Public Sub New()
    End Sub

    Protected Overrides Function CreateDisplayModes() As WebPartDisplayModeCollection
      Dim displayModes As WebPartDisplayModeCollection = MyBase.CreateDisplayModes()
      displayModes.Add(_inLineEditDisplayMode)
      Return displayModes

    End Function 

    Public ReadOnly Property InLineEditDisplayMode() As WebPartDisplayMode
        Get
            Return _inLineEditDisplayMode
        End Get
    End Property

    Private NotInheritable Class InlineWebPartEditDisplayMode
      Inherits WebPartDisplayMode

      Public Sub New()
        MyBase.New("Inline Edit Display")
      End Sub

      Public Overrides ReadOnly Property AllowPageDesign() As Boolean
        Get
          Return True
        End Get
      End Property

      Public Overrides ReadOnly Property RequiresPersonalization() _
        As Boolean
        Get
          Return True
        End Get
      End Property

      Public Overrides ReadOnly Property ShowHiddenWebParts() As Boolean
        Get
          Return False
        End Get
      End Property

      Public Overrides ReadOnly Property AssociatedWithToolZone() _
        As Boolean
        Get
          Return False
        End Get
      End Property

      Public Overrides Function IsEnabled(ByVal webPartManager _
        As WebPartManager) As Boolean

        Return True

      End Function

    End Class

  End Class

End Namespace

Para executar o exemplo de código, carregue a página num navegador. Repare que a página está atualmente em modo de navegação e não é visível nenhum botão. Usando o controlo de lista suspensa do Modo de Visualização , altere a página para o modo de Edição Inline e repare que agora o botão é visível no controlo inferior do utilizador. Adiciona algum texto e clica no botão para atualizar o controlo. Note que a visualização da página voltou ao modo de navegação, o texto que introduziu está agora exibido, e o botão está novamente oculto porque a página não está no modo de visualização personalizada.

Observações

A WebPartDisplayModeCollection classe foi concebida para conter uma coleção de WebPartDisplayMode objetos. É utilizado principalmente pelo WebPartManager controlo para gerir coleções de WebPartDisplayMode objetos.

Um modo de exibição é uma visualização especial de uma página Web que aparece quando esta é atribuída como o modo de exibição atual na WebPartManager.DisplayMode propriedade. Os modos de visualização são usados no conjunto de controlos Web Parts para criar visualizações de página nas quais os utilizadores podem realizar tarefas especiais, como editar controlos ou reorganizar o layout de uma página. O WebPartManager controlo define vários modos de visualização, incluindo BrowseDisplayMode, DesignDisplayMode, EditDisplayMode, CatalogDisplayMode, e ConnectDisplayMode. A coleção de modos de exibição é referenciada pela WebPartManager.DisplayModes propriedade.

Em qualquer página Web específica que utilize controlos de Web Parts, apenas certos modos de visualização estão disponíveis. O modo de navegação por defeito e o modo de design estão quase sempre disponíveis, mas os outros modos de exibição só estão disponíveis se os seus tipos de zona correspondentes estiverem presentes na página. Para mais informações, consulte a WebPartDisplayMode visão geral da turma.

O WebPartManager controlo acompanha os modos de visualização disponíveis numa página com a sua SupportedDisplayModes propriedade. Esta propriedade refere-se a um WebPartDisplayModeCollection objeto que contém todos os modos de visualização suportados.

A WebPartDisplayModeCollection classe não tem um construtor exposto, por isso não podes criar a tua própria nova instância dele. Se criar um objeto personalizado WebPartDisplayMode e quiser que faça parte da coleção de modos de exibição suportados no WebPartManager controlo, deve herdar da WebPartManager classe, sobrescrever o CreateDisplayModes método, chamar o método base para criar a coleção e depois adicionar quaisquer modos de exibição personalizados à coleção usando o seu Add método.

A WebPartDisplayModeCollection classe tem duas propriedades públicas. A IsReadOnly propriedade é uma propriedade de apenas leitura que indica se a coleção é apenas de leitura. A propriedade sobrecarregada Item[] permite o acesso aos membros da coleção.

A WebPartDisplayModeCollection aula também tem vários métodos. O Add método, já mencionado, permite-lhe adicionar WebPartDisplayMode objetos à coleção. O Contains método determina se existe um determinado modo de exibição na coleção. O CopyTo método copia a coleção para um array de objetos. O IndexOf método devolve o índice de um determinado modo de exibição dentro da coleção. Finalmente, o Insert método permite inserir um objeto de modo de exibição num índice específico da coleção.

Propriedades

Name	Description
Capacity	Obtém ou define o número de elementos que podem CollectionBase conter. (Herdado de CollectionBase)
Count	Obtém o número de elementos contidos na CollectionBase instância. Esta propriedade não pode ser substituída. (Herdado de CollectionBase)
InnerList	Obtém um ArrayList contendo a lista de elementos na CollectionBase instância. (Herdado de CollectionBase)
IsReadOnly	Recebe um valor que indica se a coleção é apenas de leitura.
Item[Int32]	Obtém um membro específico da coleção de acordo com o seu índice.
Item[String]	Obtém um membro específico da coleção de acordo com um identificador único.
List	Obtém um IList contendo a lista de elementos na CollectionBase instância. (Herdado de CollectionBase)

Métodos

Name	Description
Add(WebPartDisplayMode)	Adiciona um WebPartDisplayMode objeto à coleção.
Clear()	Remove todos os objetos da CollectionBase instância. Este método não pode ser ultrapassado. (Herdado de CollectionBase)
Contains(WebPartDisplayMode)	Devolve um valor que indica se um objeto específico WebPartDisplayMode existe na coleção.
CopyTo(WebPartDisplayMode[], Int32)	Copia a coleção para um array de WebPartDisplayMode objetos.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetEnumerator()	Devolve um enumerador que itera pela CollectionBase instância. (Herdado de CollectionBase)
GetHashCode()	Serve como função de hash predefinida. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IndexOf(WebPartDisplayMode)	Devolve a posição de um membro específico da coleção.
Insert(Int32, WebPartDisplayMode)	Insere um WebPartDisplayMode objeto na coleção na posição de índice especificada.
MemberwiseClone()	Cria uma cópia superficial do atual Object. (Herdado de Object)
OnClear()	Realiza processos personalizados adicionais ao limpar o conteúdo da CollectionBase instância. (Herdado de CollectionBase)
OnClearComplete()	Realiza processos personalizados adicionais após limpar o conteúdo da CollectionBase instância. (Herdado de CollectionBase)
OnInsert(Int32, Object)	Realiza processos personalizados adicionais antes de inserir um novo elemento na CollectionBase instância. (Herdado de CollectionBase)
OnInsertComplete(Int32, Object)	Executa processos personalizados adicionais após inserir um novo elemento na CollectionBase instância. (Herdado de CollectionBase)
OnRemove(Int32, Object)	Realiza processos personalizados adicionais ao remover um elemento da CollectionBase instância. (Herdado de CollectionBase)
OnRemoveComplete(Int32, Object)	Executa processos personalizados adicionais após remover um elemento da CollectionBase instância. (Herdado de CollectionBase)
OnSet(Int32, Object, Object)	Realiza processos personalizados adicionais antes de definir um valor na CollectionBase instância. (Herdado de CollectionBase)
OnSetComplete(Int32, Object, Object)	Executa processos personalizados adicionais após definir um valor na CollectionBase instância. (Herdado de CollectionBase)
OnValidate(Object)	Realiza processos personalizados adicionais ao validar um valor. (Herdado de CollectionBase)
RemoveAt(Int32)	Remove o elemento no índice especificado da CollectionBase instância. Este método não é ultrapassível. (Herdado de CollectionBase)
ToString()	Devolve uma cadeia que representa o objeto atual. (Herdado de Object)

Implementações de Interface Explícita

Name	Description
ICollection.CopyTo(Array, Int32)	Copia a totalidade CollectionBase para uma unidimensional Arraycompatível , começando no índice especificado do array alvo. (Herdado de CollectionBase)
ICollection.IsSynchronized	Recebe um valor que indica se o acesso ao CollectionBase é sincronizado (thread safe). (Herdado de CollectionBase)
ICollection.SyncRoot	Obtém um objeto que pode ser usado para sincronizar o acesso ao CollectionBase. (Herdado de CollectionBase)
IList.Add(Object)	Adiciona um objeto ao final do CollectionBase. (Herdado de CollectionBase)
IList.Contains(Object)	Determina se o CollectionBase contém um elemento específico. (Herdado de CollectionBase)
IList.IndexOf(Object)	Procura o especificado Object e devolve o índice baseado em zero da primeira ocorrência dentro de todo CollectionBaseo . (Herdado de CollectionBase)
IList.Insert(Int32, Object)	Insere um elemento no CollectionBase índice especificado. (Herdado de CollectionBase)
IList.IsFixedSize	Obtém um valor que indica se o CollectionBase tem um tamanho fixo. (Herdado de CollectionBase)
IList.IsReadOnly	Recebe um valor que indica se o CollectionBase é apenas de leitura. (Herdado de CollectionBase)
IList.Item[Int32]	Obtém ou define o elemento no índice especificado. (Herdado de CollectionBase)
IList.Remove(Object)	Remove a primeira ocorrência de um objeto específico do CollectionBase. (Herdado de CollectionBase)

Métodos da Extensão

Name	Description
AsParallel(IEnumerable)	Permite a paralelização de uma consulta.
AsQueryable(IEnumerable)	Converte um IEnumerable para um IQueryable.
Cast<TResult>(IEnumerable)	Conjura os elementos de an IEnumerable para o tipo especificado.
OfType<TResult>(IEnumerable)	Filtra os elementos de um IEnumerable com base num tipo especificado.

Aplica-se a

Ver também

Comentários

Esta página foi útil?