WebPartDisplayModeCollection Clase

Referencia

Definición

Espacio de nombres:: System.Web.UI.WebControls.WebParts

Ensamblado:: System.Web.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Contiene una colección de objetos WebPartDisplayMode. Esta clase no puede heredarse.

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

Herencia: Object

CollectionBase
WebPartDisplayModeCollection

Ejemplos

En el ejemplo de código siguiente se muestra cómo trabajar con la WebPartDisplayModeCollection clase . El punto clave es que debe heredar de la WebPartManager clase e invalidar el CreateDisplayModes método para agregar un objeto personalizado WebPartDisplayMode a la WebPartDisplayModeCollection colección creada por el WebPartManager control .

Este ejemplo de código tiene cinco partes:

Control de usuario que permite cambiar los modos de visualización en una página de elementos web.
Página web que hospeda los demás controles.
Un control de usuario que reside en una WebPartZone zona de la página web y permite escribir y mostrar texto en una etiqueta.
Un archivo de código fuente que contiene dos controles. Uno es un control personalizado WebPartManager ; el otro es un objeto personalizado WebPartDisplayMode que se va a agregar a los modos de presentación predeterminados de la página.
Explicación de cómo funciona el ejemplo.

El código fuente de la primera parte del ejemplo de código, el control de usuario que permite cambiar los modos de presentación, procede de otro tema. Para que este ejemplo de código funcione, debe obtener el archivo .ascx para el control de usuario del tema Walkthrough: Changing Display Modes on a Web Parts Page y colocar el archivo en la misma carpeta que la página .aspx en este ejemplo de código.

La segunda parte del ejemplo es la página web. Contiene dos WebPartZone controles, ambos controles de usuario y el control personalizado WebPartManager . Observe las Register directivas de la parte superior de la página para hacer referencia a los controles de usuario y el espacio de nombres de los controles 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>

La tercera parte del ejemplo es el control de usuario para escribir y mostrar texto. Observe que usa un MultiView control para crear varias vistas de la interfaz de usuario (UI). Se muestra una vista con el botón, el otro sin . Observe que en el método invalidado OnPreRender , el código comprueba si la página está actualmente en el modo de presentación personalizado y, si es así, muestra la primera vista del control de usuario, que incluye el botón. Si la página no está en el modo de presentación personalizado (por ejemplo, si la página está en modo de exploración o diseño), el botón está oculto.

Importante

Este ejemplo tiene un cuadro de texto que acepta datos proporcionados por el usuario, lo que puede suponer una amenaza para la seguridad. De forma predeterminada, ASP.NET Web Pages valida que los datos proporcionados por el usuario no incluyen elementos HTML ni de script. Para más información, consulte Información general sobre los ataques mediante 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>

La cuarta parte del ejemplo es el archivo de origen de las dos clases personalizadas. Observe que la clase personalizada WebPartManager invalida el CreateDisplayModes método , llama al método base para agregar todos los modos de presentación predeterminados y, a continuación, agrega el modo de presentación personalizado. La clase de modo de presentación personalizada, InLineEditDisplayMode, simplemente hereda de WebPartDisplayMode, establece el nombre del modo de presentación en el constructor e invalida una serie de las propiedades base para establecer las características de la presentación personalizada.

Para que se ejecute el ejemplo de código, debe compilar este código fuente. Puede compilarlo explícitamente y colocar el ensamblado resultante en la carpeta Bin del sitio web o en la caché global de ensamblados. Como alternativa, puede colocar el código fuente en la carpeta App_Code del sitio, donde se compilará dinámicamente en tiempo de ejecución. Para ver un tutorial que muestra cómo compilar, vea Tutorial: Desarrollo y uso de un control 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 ejecutar el ejemplo de código, cargue la página en un explorador. Observe que la página está actualmente en modo de exploración y que no hay ningún botón visible. Con el control de lista desplegable Modo de presentación , cambie la página a Modo de presentación en línea y observe que ahora el botón está visible en el control de usuario inferior. Agregue texto y haga clic en el botón para actualizar el control. Observe que la presentación de la página se devuelve al modo de exploración, ahora se muestra el texto que escribió y el botón se oculta una vez más porque la página no está en el modo de presentación personalizado.

Comentarios

La WebPartDisplayModeCollection clase está diseñada para contener una colección de WebPartDisplayMode objetos . Se usa principalmente por el WebPartManager control para administrar colecciones de WebPartDisplayMode objetos.

Un modo de presentación es una vista especial de una página web que aparece cuando se asigna como el modo de presentación actual en la WebPartManager.DisplayMode propiedad . Los modos de visualización se usan en el conjunto de controles de elementos web para crear vistas de página en las que los usuarios pueden realizar tareas especiales, como controles de edición o reorganizar el diseño de una página. El WebPartManager control define varios modos de presentación, incluidos BrowseDisplayMode, DesignDisplayMode EditDisplayMode, , CatalogDisplayModey ConnectDisplayMode. La propiedad hace referencia a la WebPartManager.DisplayModes colección de modos de presentación.

En cualquier página web determinada que use controles de elementos web, solo están disponibles determinados modos de presentación. El modo de exploración predeterminado y el modo de diseño están casi siempre disponibles, pero los demás modos de presentación solo están disponibles si sus tipos de zona correspondientes están presentes en la página. Para obtener más información, consulte la información general de la WebPartDisplayMode clase.

El WebPartManager control realiza un seguimiento de los modos de presentación disponibles en una página con su SupportedDisplayModes propiedad . Esta propiedad hace referencia a un WebPartDisplayModeCollection objeto que contiene todos los modos de presentación admitidos.

La WebPartDisplayModeCollection clase no tiene un constructor expuesto, por lo que no puede crear su propia instancia de ella. Si crea un objeto personalizado WebPartDisplayMode y quiere que forme parte de la colección de modos de presentación admitidos en el WebPartManager control , debe heredar de la WebPartManager clase , invalidar el CreateDisplayModes método , llamar al método base para crear la colección y, a continuación, agregar los modos de presentación personalizados a la colección mediante su Add método .

La WebPartDisplayModeCollection clase tiene dos propiedades públicas. La IsReadOnly propiedad es una propiedad de solo lectura que indica si la colección es de solo lectura. La propiedad sobrecargada Item[] proporciona acceso a los miembros de la colección.

La WebPartDisplayModeCollection clase también tiene varios métodos. El Add método, ya mencionado, permite agregar WebPartDisplayMode objetos a la colección. El Contains método determina si existe un modo de presentación determinado en la colección. El CopyTo método copia la colección en una matriz de objetos . El IndexOf método devuelve el índice de un modo de presentación determinado dentro de la colección. Por último, el Insert método permite insertar un objeto de modo de presentación en un índice determinado de la colección.

Propiedades

Capacity	Obtiene o establece el número de elementos que puede contener CollectionBase. (Heredado de CollectionBase)
Count	Obtiene el número de elementos contenidos en la instancia de CollectionBase. Esta propiedad no se puede invalidar. (Heredado de CollectionBase)
InnerList	Obtiene una colección ArrayList que contiene la lista de elementos incluidos en la instancia de CollectionBase. (Heredado de CollectionBase)
IsReadOnly	Obtiene un valor que indica si la colección es de solo lectura.
Item[Int32]	Obtiene un miembro concreto de la colección en función de su índice.
Item[String]	Obtiene un miembro específico de la colección en función de un identificador único.
List	Obtiene una colección IList que contiene la lista de elementos incluidos en la instancia de CollectionBase. (Heredado de CollectionBase)

Métodos

Add(WebPartDisplayMode)	Agrega un objeto WebPartDisplayMode a la colección.
Clear()	Elimina todos los objetos de la instancia de CollectionBase. Este método no se puede invalidar. (Heredado de CollectionBase)
Contains(WebPartDisplayMode)	Devuelve un valor que indica si existe un objeto WebPartDisplayMode concreto en la colección.
CopyTo(WebPartDisplayMode[], Int32)	Copia la colección en una matriz de objetos WebPartDisplayMode.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetEnumerator()	Devuelve un enumerador que recorre en iteración la instancia de CollectionBase. (Heredado de CollectionBase)
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IndexOf(WebPartDisplayMode)	Devuelve la posición de un miembro determinado de la colección.
Insert(Int32, WebPartDisplayMode)	Inserta un objeto WebPartDisplayMode en la colección, en la posición de índice especificada.
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
OnClear()	Realiza procesos personalizados adicionales al borrar el contenido de la instancia CollectionBase. (Heredado de CollectionBase)
OnClearComplete()	Realiza procesos personalizados adicionales después de borrar el contenido de la instancia de CollectionBase. (Heredado de CollectionBase)
OnInsert(Int32, Object)	Realiza procesos personalizados adicionales antes de insertar un nuevo elemento en la instancia de CollectionBase. (Heredado de CollectionBase)
OnInsertComplete(Int32, Object)	Realiza procesos personalizados adicionales después de insertar un nuevo elemento en la instancia de CollectionBase. (Heredado de CollectionBase)
OnRemove(Int32, Object)	Realiza procesos de personalización adicionales al quitar un elemento de la instancia de CollectionBase. (Heredado de CollectionBase)
OnRemoveComplete(Int32, Object)	Realiza procesos personalizados adicionales después de quitar un elemento de la instancia de CollectionBase. (Heredado de CollectionBase)
OnSet(Int32, Object, Object)	Realiza procesos personalizados adicionales antes de establecer un valor en la instancia de CollectionBase. (Heredado de CollectionBase)
OnSetComplete(Int32, Object, Object)	Realiza procesos personalizados adicionales después de establecer un valor en la instancia de CollectionBase. (Heredado de CollectionBase)
OnValidate(Object)	Realiza procesos de personalización adicionales al validar un valor. (Heredado de CollectionBase)
RemoveAt(Int32)	Quita el elemento que se encuentra en el índice especificado de la instancia de CollectionBase. Este método no se puede reemplazar. (Heredado de CollectionBase)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Implementaciones de interfaz explícitas

ICollection.CopyTo(Array, Int32)	Copia la totalidad de CollectionBase en una matriz Array unidimensional compatible, comenzando en el índice especificado de la matriz de destino. (Heredado de CollectionBase)
ICollection.IsSynchronized	Obtiene un valor que indica si el acceso a la interfaz CollectionBase está sincronizado (es seguro para subprocesos). (Heredado de CollectionBase)
ICollection.SyncRoot	Obtiene un objeto que se puede usar para sincronizar el acceso a CollectionBase. (Heredado de CollectionBase)
IList.Add(Object)	Agrega un objeto al final de CollectionBase. (Heredado de CollectionBase)
IList.Contains(Object)	Determina si CollectionBase contiene un elemento específico. (Heredado de CollectionBase)
IList.IndexOf(Object)	Busca el objeto Object especificado y devuelve el índice de base cero de la primera aparición en toda la colección CollectionBase. (Heredado de CollectionBase)
IList.Insert(Int32, Object)	Inserta un elemento en CollectionBase en el índice especificado. (Heredado de CollectionBase)
IList.IsFixedSize	Obtiene un valor que indica si la interfaz CollectionBase tiene un tamaño fijo. (Heredado de CollectionBase)
IList.IsReadOnly	Obtiene un valor que indica si CollectionBase es de solo lectura. (Heredado de CollectionBase)
IList.Item[Int32]	Obtiene o establece el elemento en el índice especificado. (Heredado de CollectionBase)
IList.Remove(Object)	Quita la primera aparición de un objeto específico de la interfaz CollectionBase. (Heredado de CollectionBase)

Métodos de extensión

Cast<TResult>(IEnumerable)	Convierte los elementos de IEnumerable en el tipo especificado.
OfType<TResult>(IEnumerable)	Filtra los elementos de IEnumerable en función de un tipo especificado.
AsParallel(IEnumerable)	Habilita la paralelización de una consulta.
AsQueryable(IEnumerable)	Convierte una interfaz IEnumerable en IQueryable.

Se aplica a

Compartir a través de