WebPartVerb Classe

Definição

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

Herança

Object

WebPartVerb

Atributos

TypeConverterAttribute

Implementações

IStateManager

Exemplos

O exemplo de código seguinte mostra como criar um objeto personalizado WebPartVerb e uma zona personalizada que usa o OnCreateVerbs método para adicionar o verbo ao menu de verbos de cada WebPart controlo contido na zona. Existem quatro partes no exemplo de código:

• Um ficheiro fonte que contém um controlo personalizado WebPart simples que mostra algum texto.

• Um ficheiro fonte que contém um objeto personalizado WebPartVerb , e uma zona personalizada WebPartZoneBase simples que sobrepõe o OnCreateVerbs método para adicionar o verbo personalizado aos WebPart controlos na zona.

• Uma página Web que contém a zona personalizada e o controlo personalizado WebPart .

• Uma explicação de como funciona o exemplo.

A primeira parte do exemplo de código contém código-fonte que cria um controlo simples WebPart que mostra algum texto. 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. Este exemplo de código utiliza a abordagem de compilação dinâmica. Para um guia que demonstra como compilar, consulte Guia: Desenvolvimento e Utilização de um Controlo 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

A segunda parte do exemplo contém código-fonte para criar a zona personalizada e o objeto personalizado WebPartVerb . Note que a zona sobrepõe o OnCreateVerbs método para adicionar o verbo personalizado a quaisquer WebPart controlos dentro da zona. O verbo é adicionado por defeito ao menu de verbos dos controlos. Note que, no código para o verbo personalizado, o construtor do verbo usa um handler de cliques do servidor, e que o método chamado cria uma cópia completa de qualquer controlo que herde diretamente da WebPart classe, adicionando a cópia recém-criada à mesma zona. Tal como na primeira parte do exemplo do código, este código-fonte tem de ser compilado, e neste exemplo o ficheiro fonte foi colocado numa subpasta App_Code para ser compilado dinamicamente.

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

A terceira parte do exemplo de código é a página Web que aloja os controlos. Note que existe uma Register diretiva perto do topo da página para declarar o namespace dos controlos personalizados. Nenhuma assembly é declarada porque este exemplo utiliza compilação dinâmica. O controlo personalizado WebPart é declarado dentro da zona personalizada. Também podias declarar outros WebPart controlos nesta zona, e o verbo personalizado seria adicionado aos menus de verbos deles.

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

Carrega a página num navegador e clica no menu de verbos no controlo personalizado WebPart . O verbo Copiar Web Part deve ser visível. Clica no verbo e nota que uma cópia do controlo é adicionada à zona.

Observações

Os verbos Web Parts são elementos interativos da interface, normalmente representados por botões ou hiperligações, que aparecem em páginas que utilizam controlos Web Parts. Os utilizadores clicam em verbos para realizar ações comuns na interface de utilizador dos controlos Web Parts, como fechar um WebPart controlo ou fechar o modo de visualização de edição (uma vista de página especial associada ao EditorZone controlo). Todos os verbos padrão fornecidos com o conjunto de controlo Web Parts estão associados a uma zona Web Parts (WebPartZone, EditorZone, CatalogZone, ou ConnectionsZone) ou a um controlo Web Parts Part (WebPart, GenericWebPart, EditorPart, ou CatalogPart).

Quando os verbos padrão estão associados a uma zona, as suas ações aplicam-se ao nível da zona, e os verbos geralmente aparecem na área do cabeçalho ou rodapé da zona. A tabela seguinte lista os verbos ao nível da zona comum e descreve as suas ações.

Quanto aos verbos padrão associados a Part controlos, as suas ações aplicam-se ao próprio controlo (ou aos seus controlos filhos). O controlo de parte atua como um recipiente para o verbo e gere a representação do verbo. A maioria dos verbos padrão associados a controlos de parte aparece diretamente na barra de título ou num menu suspenso de verbos dentro da barra de título. Se estes verbos aparecem diretamente no cabeçalho ou num menu de verbos é determinado pela WebPartVerbRenderMode propriedade; por defeito, os verbos aparecem num menu de verbos. A tabela seguinte lista verbos comuns associados aos vários Part controlos e descreve as suas ações.

Para além dos verbos padrão fornecidos pelo conjunto de controlo Web Parts, também pode criar verbos personalizados. Um cenário comum para criar verbos personalizados é criar verbos associados a Part controlos. Quando crias estes verbos, por defeito eles aparecem no menu de verbos juntamente com os verbos padrão. A abordagem básica para criar tais verbos é herdar da WebPartVerb classe para criar um ou mais verbos personalizados. Depois cria um controlo que herde da WebPart classe base e adiciona os objetos personalizados WebPartVerb a uma WebPartVerbCollection coleção. Esta coleção pode então ser adicionada à Verbs coleção do controlo, o que fará com que os verbos personalizados apareçam automaticamente no menu de verbos do controlo em tempo de execução. Tal como nos verbos padrão, pode aceder aos verbos personalizados programaticamente num WebPart controlo.

As aplicações Web Parts podem usar controlos de servidor que não herdam da classe WebPart, como controlos personalizados, controlos de utilizador ou controlos ASP.NET. Estes controlos de servidor, se adicionados a uma WebPartZoneBase zona, são dinamicamente envolvidos com um GenericWebPart objeto em tempo de execução, o que lhes permite funcionar como controlos em tempo WebPart de execução. Para adicionar verbos personalizados a um controlo de servidor que não herde da WebPart classe, o controlo de servidor deve implementar a IWebActionable interface e sobrepor a sua Verbs propriedade.

Quando crias um verbo, podes criar dois tipos de gestores de eventos associados que se executam quando o utilizador clica no verbo: um gestor de eventos do lado do servidor (código que corre no servidor) e um gestor de eventos do lado do cliente (código que corre no navegador do cliente). Além disso, pode definir estados personalizados para verbos, o que é uma forma útil de fornecer pistas visuais aos utilizadores. Por exemplo, pode criar um estado indicando que um verbo foi selecionado e depois fornecer alterações apropriadas na interface para notificar o utilizador de que o verbo já está selecionado. Outro comportamento útil é a capacidade de desativar verbos; Ao fazer isto, pode impedir que os utilizadores cliquem em verbos se isso for prejudicial ou ineficaz, consoante o estado da aplicação.

A WebPartVerb classe não expõe métodos únicos; os seus métodos expostos são todos sobreposições dos métodos base. No entanto, contém várias propriedades que os promotores devem conhecer. A Checked propriedade indica se um verbo está atualmente selecionado. As ClientClickHandler propriedades e ServerClickHandler referem-se aos respetivos handlers dentro da classe (caso existam) para eventos de clique do cliente e do servidor. A Description propriedade contém texto que descreve o propósito de um verbo numa ToolTip quando os utilizadores posicionam um ponteiro do rato sobre o verbo na interface. A Enabled propriedade indica o estado atual de um verbo, que determina se o utilizador pode clicar no verbo e executar a sua ação. A ID propriedade fornece um ID único para o objeto verbo. A ImageUrl propriedade contém uma URL para uma imagem que pode ser usada para representar um verbo na interface em vez da renderização padrão (tipicamente um botão ou um hiperlink). A Text propriedade contém o texto do rótulo que aparece diretamente no verbo na interface. A propriedade sobreposta Visible determina se um verbo está atualmente apresentado na interface. Os verbos são frequentemente escondidos ou desativados em diferentes momentos numa aplicação Web Parts; Por exemplo, verbos especiais (como o verbo editar e o verbo conectar) são exibidos apenas quando existem os controlos, definições e modos de visualização apropriados na página para permitir que esses verbos tomem ações significativas.

Outros elementos-chave para trabalhar com verbos incluem o WebPartZoneBase.OnCreateVerbs método, que é um gestor de eventos que pode ser sobreposto para um tratamento personalizado do processo de criação do verbo, e o WebPartZoneBase.CreateVerbs evento.

Ver também

• Verbs
• Verbs
• WebPartVerbCollection
• ASP.NET Controlos de Web Parts