WebPartVerb Clase

Definición

public ref class WebPartVerb : System::Web::UI::IStateManager

[System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.EmptyStringExpandableObjectConverter))]
public class WebPartVerb : System.Web.UI.IStateManager

[<System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.EmptyStringExpandableObjectConverter))>]
type WebPartVerb = class
    interface IStateManager

Public Class WebPartVerb
Implements IStateManager

Herencia

Object

WebPartVerb

Atributos

TypeConverterAttribute

Implementaciones

IStateManager

Ejemplos

En el ejemplo de código siguiente se muestra cómo crear un objeto personalizado WebPartVerb y una zona personalizada que usa el método para agregar el OnCreateVerbs verbo al menú verbo de cada WebPart control contenido en la zona. Hay cuatro partes en el ejemplo de código:

• Un archivo de código fuente que contiene un control personalizado WebPart simple que muestra texto.

• Un archivo de origen que contiene un objeto personalizado WebPartVerb y una zona personalizada WebPartZoneBase simple que invalida el OnCreateVerbs método para agregar el verbo personalizado a WebPart los controles de la zona.

• Página web que contiene la zona personalizada y el control personalizado WebPart .

• Explicación de cómo funciona el ejemplo.

La primera parte del ejemplo de código contiene código fuente que crea un control simple WebPart que muestra texto. 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. En este ejemplo de código se usa el enfoque de compilación dinámica. 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.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Security.Permissions;
using System.Collections.Generic;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

namespace Samples.AspNet.CS.Controls
{

    // This code snippet creates a simple Web Part control.
    [AspNetHostingPermission(SecurityAction.Demand,
      Level = AspNetHostingPermissionLevel.Minimal)]
    [AspNetHostingPermission(SecurityAction.InheritanceDemand,
      Level = AspNetHostingPermissionLevel.Minimal)]
    public class SimpleControl : WebPart
    {

        private String _text = "Simple control text";

        public string Text
        {
            get
            {
                if (_text != null)
                    return _text;
                else
                    return string.Empty;
            }
            set { _text = value; }
        }

        protected override void Render(System.Web.UI.HtmlTextWriter 
      writer)
        {
            writer.Write(this.Text);
        }
    }
}

Imports System.Data
Imports System.Configuration
Imports System.Web
Imports System.Web.Security
Imports System.Collections.Generic
Imports System.Security.Permissions
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Imports System.Web.UI.HtmlControls

' This code snippet creates a simple Web Part control.
Namespace Samples.AspNet.VB.Controls

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class SimpleControl
    Inherits System.Web.UI.WebControls.WebParts.WebPart

    Private _text As String = "Simple control text"

    Public Property [Text]() As String
      Get
        If Not (_text Is Nothing) Then
          Return _text
        Else
          Return String.Empty
        End If
      End Get
      Set(ByVal value As String)
        _text = value
      End Set
    End Property

    Protected Overrides Sub Render(ByVal writer _
      As System.Web.UI.HtmlTextWriter)

      writer.Write(Me.Text)

    End Sub

  End Class

End Namespace

La segunda parte del ejemplo contiene código fuente para crear la zona personalizada y el objeto personalizado WebPartVerb . Tenga en cuenta que la zona invalida el OnCreateVerbs método para agregar el verbo personalizado a los WebPart controles de la zona. El verbo se agrega de forma predeterminada al menú verbos de los controles. Tenga en cuenta que, en el código del verbo personalizado, el constructor del verbo usa un controlador de clic de servidor y que el método llamado crea una copia completa de cualquier control que hereda directamente de la WebPart clase y agrega la copia recién creada a la misma zona. Al igual que la primera parte del ejemplo de código, este código fuente debe compilarse y, en este ejemplo, el archivo de código fuente se colocó en una subcarpeta App_Code que se va a compilar dinámicamente.

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Security.Permissions;
using System.Collections.Generic;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

namespace Samples.AspNet.CS.Controls
{
/* 
This code sample creates a Web Part zone and adds the 
"Copy Web Part" verb to any control in the zone.
*/
[AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
public class ZoneWithAddedVerb : WebPartZone
{

  protected override void OnCreateVerbs(WebPartVerbsEventArgs e)
  {
    List<WebPartVerb> newVerbs = new List<WebPartVerb>();
    newVerbs.Add(new CopyWebPartVerb(CopyWebPartToNewOne));
    e.Verbs = new WebPartVerbCollection(e.Verbs,newVerbs);
    base.OnCreateVerbs(e);
  }

  void CopyWebPartToNewOne(object sender, WebPartEventArgs e)
  {
    WebPartManager wpmgr = 
      WebPartManager.GetCurrentWebPartManager(Page);
    System.Web.UI.WebControls.WebParts.WebPart wp;
    Type tp = e.WebPart.GetType(); 
    wp = (System.Web.UI.WebControls.WebParts.WebPart)Activator.CreateInstance(tp);   
    wpmgr.AddWebPart(wp, e.WebPart.Zone, e.WebPart.ZoneIndex + 1);
  }
}
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  internal class CopyWebPartVerb : WebPartVerb
  {
    private const String _copyWebPartImageUrl = "~/CopyVerb.ico";

    internal CopyWebPartVerb(WebPartEventHandler serverClickHandler) :  
       base("MyVerb", serverClickHandler)
    { }
    public override string Text
    {
      get { return "Copy Web Part"; }
      set { ;}
    }
    public override string Description
    {
      get { return "This verb will copy this web part control " +
        "to a new one below"; }
      set { ; }
    }
    public override bool Enabled
    {
      get { return base.Enabled; }
      set { base.Enabled = value; }
    }
    
    public override string ImageUrl
    {
      get { return _copyWebPartImageUrl; }
      set { ; }
    }
  }
}

Imports System.Data
Imports System.Configuration
Imports System.Web
Imports System.Web.Security
Imports System.Security.Permissions
Imports System.Collections.Generic
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Imports System.Web.UI.HtmlControls

' This code sample creates a Web Part zone and adds the 
' "Copy Web Part" verb to any control in the zone.
Namespace Samples.AspNet.VB.Controls

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class ZoneWithAddedVerb
    Inherits WebPartZone

    'public class ExtendedWebPartZoneBase 
    Protected Overrides Sub OnCreateVerbs(ByVal e _
      As WebPartVerbsEventArgs)

      Dim newVerbs As List(Of WebPartVerb) = _
        New List(Of WebPartVerb)
      newVerbs.Add(New CopyWebPartVerb(AddressOf CopyWebPartToNewOne))
      e.Verbs = New WebPartVerbCollection(e.Verbs, newVerbs)
      MyBase.OnCreateVerbs(e)

    End Sub


    Sub CopyWebPartToNewOne(ByVal sender As Object, _
      ByVal e As WebPartEventArgs)

      Dim wpmgr As WebPartManager = _
        WebPartManager.GetCurrentWebPartManager(Page)
      Dim wp As System.Web.UI.WebControls.WebParts.WebPart
      Dim tp As Type = e.WebPart.GetType()
      wp = CType(Activator.CreateInstance(tp), _
        System.Web.UI.WebControls.WebParts.WebPart)
      wpmgr.AddWebPart(wp, e.WebPart.Zone, e.WebPart.ZoneIndex + 1)

    End Sub

  End Class


  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Friend Class CopyWebPartVerb
    Inherits WebPartVerb
    Private Const _copyWebPartImageUrl As String = "~/CopyVerb.ico"

    Friend Sub New(ByVal serverClickHandler As WebPartEventHandler)
      MyBase.New("MyVerb", serverClickHandler)

    End Sub

    Public Overrides Property [Text]() As String
      Get
        Return "Copy Web Part"
      End Get
      Set(ByVal value As String)
      End Set
    End Property

    Public Overrides Property Description() As String
      Get
        Return "This verb will copy this web part control to a " _
               & "new one below"
      End Get
      Set(ByVal value As String)
      End Set
    End Property

    Public Overrides Property Enabled() As Boolean
      Get
        Return MyBase.Enabled
      End Get
      Set(ByVal value As Boolean)
        MyBase.Enabled = value
      End Set
    End Property
    
    Public Overrides Property ImageUrl() As String
      Get
        Return Me._copyWebPartImageUrl
      End Get
      Set(ByVal value As String)
      End Set
    End Property

  End Class

End Namespace

La tercera parte del ejemplo de código es la página web que hospeda los controles. Tenga en cuenta que hay una Register directiva cerca de la parte superior de la página para declarar el espacio de nombres de los controles personalizados. No se declara ningún ensamblado porque en este ejemplo se usa la compilación dinámica. El control personalizado WebPart se declara dentro de la zona personalizada. También puede declarar otros WebPart controles de esta zona y el verbo personalizado también se agregaría a sus menús de verbos.

<%@ Page Language="C#" %>
<%@ Register TagPrefix="verbsample" 
    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">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <asp:WebPartManager ID="WebPartManager1" runat="server" />
    <verbsample:ZoneWithAddedVerb id="ZoneWithAddedVerb1" 
      HeaderText="Zone with Added Verb" runat="server">
        <ZoneTemplate>
           <verbsample:SimpleControl id="SimpleControl1" 
            title="Simple Control" runat="server" /> 
        </ZoneTemplate>
        </verbsample:ZoneWithAddedVerb>
     </form>
</body>
</html>

<%@ Page Language="VB" %>
<%@ Register TagPrefix="verbsample" 
    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">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <asp:WebPartManager ID="WebPartManager1" runat="server" />
    <verbsample:ZoneWithAddedVerb id="ZoneWithAddedVerb1" 
      HeaderText="Zone with Added Verb" runat="server">
        <ZoneTemplate>
           <verbsample:SimpleControl id="SimpleControl1" 
            title="Simple Control" runat="server" /> 
        </ZoneTemplate>
        </verbsample:ZoneWithAddedVerb>
     </form>
</body>
</html>

Cargue la página en un explorador y haga clic en el menú verbos del control personalizado WebPart . El verbo Copiar elemento web debe estar visible. Haga clic en el verbo y observe que se agrega una copia del control a la zona.

Comentarios

Los verbos de elementos web son elementos interactivos de la interfaz de usuario, normalmente representados por botones o hipervínculos, que aparecen en páginas que usan controles de elementos web. Los usuarios hacen clic en verbos para llevar a cabo acciones comunes de la interfaz de usuario para los controles de elementos web, como cerrar un WebPart control o cerrar el modo de presentación de edición (una vista de página especial asociada al EditorZone control). Todos los verbos estándar proporcionados con el conjunto de controles de elementos web están asociados a una zona de elementos web (, , o ) o a un control de elementos Part web (WebPart, GenericWebPart, EditorParto CatalogPart).ConnectionsZoneCatalogZoneEditorZoneWebPartZone

Cuando los verbos estándar están asociados a una zona, sus acciones se aplican en el nivel de zona y los verbos suelen aparecer en el área de encabezado o pie de página de la zona. En la tabla siguiente se enumeran los verbos comunes de nivel de zona y se describen sus acciones.

En cuanto a los verbos estándar asociados a Part los controles, sus acciones se aplican al propio control (o a sus controles secundarios). El control de elemento actúa como contenedor para el verbo y administra la representación del verbo. La mayoría de los verbos estándar asociados a los controles de elementos aparecen directamente en la barra de título o en un menú de verbos desplegables dentro de la barra de título. Si estos verbos aparecen directamente en el encabezado o en un menú de verbos viene determinado por la WebPartVerbRenderMode propiedad ; de forma predeterminada, los verbos aparecen en un menú de verbos. En la tabla siguiente se enumeran los verbos comunes asociados a los distintos Part controles y se describen sus acciones.

Junto con los verbos estándar que se proporcionan con el conjunto de controles de elementos web, también puede crear verbos personalizados. Un escenario común para crear verbos personalizados es crear verbos asociados a Part controles. Al crear estos verbos, de forma predeterminada aparecerán en el menú de verbos junto con los verbos estándar. El enfoque básico para crear estos verbos es heredar de la WebPartVerb clase para crear uno o varios verbos personalizados. A continuación, cree un control que herede de la WebPart clase base y agregue los objetos personalizados WebPartVerb a una WebPartVerbCollection colección. A continuación, esta colección se puede agregar a la Verbs colección del control , lo que hará que los verbos personalizados aparezcan automáticamente en el menú verbos del control en tiempo de ejecución. Al igual que con los verbos estándar, puede acceder a los verbos personalizados mediante programación en un WebPart control.

Las aplicaciones de elementos web pueden usar controles de servidor que no heredan de la WebPart clase , como controles personalizados, controles de usuario o controles de ASP.NET. Estos controles de servidor, si se agregan a una WebPartZoneBase zona, se encapsulan dinámicamente con un GenericWebPart objeto en tiempo de ejecución, lo que les permite funcionar como controles en tiempo WebPart de ejecución. Para agregar verbos personalizados a un control de servidor que no hereda de la WebPart clase , el control de servidor debe implementar la IWebActionable interfaz e invalidar su Verbs propiedad.

Al crear un verbo, puede crear dos tipos de controladores de eventos asociados que se ejecutarán cuando un usuario haga clic en el verbo: un controlador de eventos del lado servidor (código que se ejecuta en el servidor) y un controlador de eventos del lado cliente (código que se ejecuta en el explorador cliente). Además, puede definir estados personalizados para verbos, que es una manera útil de proporcionar indicaciones visuales a los usuarios. Por ejemplo, podría crear un estado que indique que se ha seleccionado un verbo y, a continuación, proporcionar los cambios adecuados en la interfaz de usuario para notificar al usuario que el verbo ya está seleccionado. Otro comportamiento útil es la capacidad de deshabilitar verbos; al hacerlo, puede impedir que los usuarios hagan clic en verbos si hacerlo sería perjudicial o ineficaz en función del estado de la aplicación.

La WebPartVerb clase no expone ningún método único; sus métodos expuestos son todas invalidaciones de métodos base. Sin embargo, contiene una serie de propiedades para que los desarrolladores tengan en cuenta. La Checked propiedad indica si un verbo está seleccionado actualmente. Las ClientClickHandler propiedades y ServerClickHandler hacen referencia a los controladores respectivos dentro de la clase (si existe alguno) para los eventos de clic de cliente y servidor. La Description propiedad contiene texto que describe el propósito de un verbo en una información sobre herramientas cuando los usuarios colocan un puntero del mouse sobre el verbo en la interfaz de usuario. La Enabled propiedad indica el estado actual de un verbo, que determina si un usuario puede hacer clic en el verbo y ejecutar su acción. La ID propiedad proporciona un identificador único para el objeto de verbo. La ImageUrl propiedad contiene una dirección URL a una imagen que se puede usar para representar un verbo en la interfaz de usuario en lugar de la representación predeterminada (normalmente un botón o un hipervínculo). La Text propiedad contiene el texto de la etiqueta que aparece directamente en el verbo de la interfaz de usuario. La propiedad invalidada Visible determina si un verbo se muestra actualmente en la interfaz de usuario. Los verbos suelen estar ocultos o deshabilitados en momentos diferentes en una aplicación de elementos web; Por ejemplo, los verbos especiales (como el verbo de edición y el verbo connect) solo se muestran cuando existen los controles, la configuración y los modos de presentación adecuados en la página para permitir que esos verbos realicen una acción significativa.

Otros miembros clave para trabajar con verbos incluyen el WebPartZoneBase.OnCreateVerbs método , que es un controlador de eventos que se puede invalidar para el control personalizado del proceso de creación de verbos y el WebPartZoneBase.CreateVerbs evento .

Constructores

Propiedades

Métodos

Implementaciones de interfaz explícitas

Se aplica a

Consulte también

• Verbs
• Verbs
• WebPartVerbCollection
• controles de elementos web de ASP.NET