WebPartVerb Classe

Definizione

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

Ereditarietà

Object

WebPartVerb

Attributi

TypeConverterAttribute

Implementazioni

IStateManager

Esempio

Nell'esempio di codice seguente viene illustrato come creare un oggetto personalizzato WebPartVerb e una zona personalizzata che usa il OnCreateVerbs metodo per aggiungere il verbo al menu verbi di ogni WebPart controllo contenuto nella zona. L'esempio di codice include quattro parti:

• File di origine che contiene un semplice controllo personalizzato WebPart che visualizza un testo.

• File di origine che contiene un oggetto personalizzato e una semplice zona personalizzata WebPartVerbWebPartZoneBase che esegue l'override del OnCreateVerbs metodo per aggiungere il verbo personalizzato ai WebPart controlli nella zona.

• Pagina Web che contiene l'area personalizzata e il controllo personalizzato WebPart .

• Spiegazione del funzionamento dell'esempio.

La prima parte dell'esempio di codice contiene il codice sorgente che crea un controllo semplice WebPart che visualizza testo. Per eseguire l'esempio di codice, è necessario compilare questo codice sorgente. È possibile compilarlo in modo esplicito e inserire l'assembly risultante nella cartella Bin del sito Web o nella Global Assembly Cache. In alternativa, è possibile inserire il codice sorgente nella cartella App_Code del sito, in cui verrà compilato in modo dinamico in fase di esecuzione. Questo esempio di codice usa l'approccio di compilazione dinamica. Per una procedura dettagliata che illustra come eseguire la compilazione, vedere Procedura dettagliata: sviluppo e uso di un controllo server Web personalizzato.

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 seconda parte dell'esempio contiene il codice sorgente per creare la zona personalizzata e l'oggetto personalizzato WebPartVerb . Si noti che la zona esegue l'override del OnCreateVerbs metodo per aggiungere il verbo personalizzato a tutti i WebPart controlli nella zona. Il verbo viene aggiunto per impostazione predefinita al menu dei verbi dei controlli. Si noti che, nel codice per il verbo personalizzato, il costruttore per il verbo usa un gestore di clic del server e che il metodo denominato crea una copia completa di qualsiasi controllo che eredita direttamente dalla WebPart classe , aggiungendo la copia appena creata alla stessa zona. Analogamente alla prima parte dell'esempio di codice, questo codice sorgente deve essere compilato e in questo esempio il file di origine è stato inserito in una sottocartella App_Code da compilare in modo dinamico.

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 terza parte dell'esempio di codice è la pagina Web che ospita i controlli. Si noti che è presente una Register direttiva nella parte superiore della pagina per dichiarare lo spazio dei nomi dei controlli personalizzati. Nessun assembly viene dichiarato perché in questo esempio viene usata la compilazione dinamica. Il controllo personalizzato WebPart viene dichiarato all'interno della zona personalizzata. È anche possibile dichiarare altri WebPart controlli in questa zona e il verbo personalizzato verrebbe aggiunto anche ai relativi menu verbi.

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

Caricare la pagina in un browser e fare clic sul menu verbi nel controllo personalizzato WebPart . Il verbo Copia web part deve essere visibile. Fare clic sul verbo e notare che una copia del controllo viene aggiunta alla zona.

Commenti

I verbi web part sono elementi interattivi dell'interfaccia utente, in genere rappresentati da pulsanti o collegamenti ipertestuali, visualizzati nelle pagine che usano controlli Web part. Gli utenti fanno clic sui verbi per eseguire azioni comuni dell'interfaccia utente per i controlli Web part, ad esempio la chiusura di un WebPart controllo o la chiusura della modalità di visualizzazione di modifica (una visualizzazione pagina speciale associata al EditorZone controllo). Tutti i verbi standard forniti con il set di controlli Web part sono associati a un'area Web part (, , o ) o a un controllo Web part Part (WebPart, GenericWebPart, EditorParto CatalogPart).ConnectionsZoneCatalogZoneEditorZoneWebPartZone

Quando i verbi standard sono associati a una zona, le relative azioni si applicano a livello di zona e i verbi vengono in genere visualizzati nell'intestazione o nel piè di pagina della zona. La tabella seguente elenca i verbi comuni a livello di zona e ne descrive le azioni.

Per quanto riguarda i verbi standard associati ai Part controlli, le relative azioni si applicano al controllo stesso (o ai relativi controlli figlio). Il controllo della parte funge da contenitore per il verbo e gestisce il rendering del verbo. La maggior parte dei verbi standard associati ai controlli parte viene visualizzata direttamente nella barra del titolo o in un menu a discesa all'interno della barra del titolo. Se questi verbi vengono visualizzati direttamente nell'intestazione o in un menu verbi è determinato dalla WebPartVerbRenderMode proprietà. Per impostazione predefinita, i verbi vengono visualizzati in un menu verbi. La tabella seguente elenca i verbi comuni associati ai vari Part controlli e ne descrive le azioni.

Oltre ai verbi standard forniti con il set di controlli Web part, è anche possibile creare verbi personalizzati. Uno scenario comune per la creazione di verbi personalizzati consiste nel creare verbi associati ai Part controlli. Quando si creano questi verbi, per impostazione predefinita verranno visualizzati nel menu dei verbi insieme ai verbi standard. L'approccio di base per la creazione di tali verbi consiste nell'ereditare WebPartVerb dalla classe per creare uno o più verbi personalizzati. Creare quindi un controllo che eredita dalla WebPart classe base e aggiungere gli oggetti personalizzati WebPartVerb a una WebPartVerbCollection raccolta. Questa raccolta può quindi essere aggiunta alla Verbs raccolta del controllo, che causerà la visualizzazione automatica dei verbi personalizzati nel menu verbi del controllo in fase di esecuzione. Come per i verbi standard, è possibile accedere ai verbi personalizzati a livello di codice in un WebPart controllo.

Le applicazioni web part possono usare controlli server che non ereditano dalla WebPart classe, ad esempio controlli personalizzati, controlli utente o controlli ASP.NET. Questi controlli server, se aggiunti a un WebPartZoneBase fuso orario, vengono inseriti in modo dinamico con un GenericWebPart oggetto in fase di esecuzione, che consente loro di funzionare come controlli di WebPart runtime. Per aggiungere verbi personalizzati a un controllo server che non eredita dalla classe, il controllo server deve implementare l'interfaccia WebPart ed eseguire l'override della IWebActionable relativa Verbs proprietà.

Quando si crea un verbo, è possibile creare due tipi di gestori eventi associati che verranno eseguiti quando un utente fa clic sul verbo: un gestore eventi lato server (codice eseguito nel server) e un gestore eventi lato client (codice eseguito nel browser client). È anche possibile definire stati personalizzati per i verbi, che è un modo utile per fornire segnali visivi agli utenti. Ad esempio, è possibile creare uno stato che indica che è stato selezionato un verbo e quindi fornire modifiche appropriate nell'interfaccia utente per notificare all'utente che il verbo è già selezionato. Un altro comportamento utile è la possibilità di disabilitare i verbi; a questo scopo, è possibile impedire agli utenti di fare clic sui verbi se farlo sarebbe dannoso o inefficace in base allo stato dell'applicazione.

La classe non espone metodi univoci. I WebPartVerb metodi esposti sono tutti override dei metodi di base. Contiene tuttavia una serie di proprietà per gli sviluppatori che devono essere consapevoli. La Checked proprietà indica se è attualmente selezionato un verbo. Le ClientClickHandler proprietà e ServerClickHandler fanno riferimento ai rispettivi gestori all'interno della classe (se presente) per gli eventi client e server click. La Description proprietà contiene testo che descrive lo scopo di un verbo in una descrizione comando quando gli utenti posizionano un puntatore del mouse sul verbo nell'interfaccia utente. La Enabled proprietà indica lo stato corrente di un verbo, che determina se un utente può fare clic sul verbo ed eseguire la relativa azione. La ID proprietà fornisce un ID univoco per l'oggetto verbo. La ImageUrl proprietà contiene un URL per un'immagine che può essere usata per rappresentare un verbo nell'interfaccia utente al posto del rendering predefinito (in genere un pulsante o un collegamento ipertestuale). La Text proprietà contiene il testo dell'etichetta visualizzato direttamente nel verbo nell'interfaccia utente. La proprietà sottoposto a override Visible determina se un verbo è attualmente visualizzato nell'interfaccia utente. I verbi sono spesso nascosti o disabilitati in momenti diversi in un'applicazione Web part; Ad esempio, i verbi speciali (ad esempio il verbo di modifica e il verbo di connessione) vengono visualizzati solo quando i controlli, le impostazioni e le modalità di visualizzazione appropriati esistono nella pagina per consentire a tali verbi di intraprendere azioni significative.

Altri membri chiave per l'uso dei verbi includono il WebPartZoneBase.OnCreateVerbs metodo, ovvero un gestore eventi che può essere sottoposto a override per la gestione personalizzata del processo di creazione verbo e l'evento WebPartZoneBase.CreateVerbs .

Costruttori

Proprietà

Metodi

Implementazioni dell'interfaccia esplicita

Si applica a

Vedi anche

• Verbs
• Verbs
• WebPartVerbCollection
• ASP.NET controlli web part