WebPartVerb Klass

Definition

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

Arv

Object

WebPartVerb

Attribut

TypeConverterAttribute

Implementeringar

IStateManager

Exempel

I följande kodexempel visas hur du skapar ett anpassat WebPartVerb objekt och en anpassad zon som använder OnCreateVerbs metoden för att lägga till verbet i verbmenyn för varje WebPart kontroll som finns i zonen. Kodexemplet har fyra delar:

• En källfil som innehåller en enkel anpassad WebPart kontroll som visar text.

• En källfil som innehåller ett anpassat WebPartVerb objekt och en enkel anpassad WebPartZoneBase zon som åsidosätter OnCreateVerbs metoden för att lägga till det anpassade verbet WebPart i kontrollerna i zonen.

• En webbsida som innehåller den anpassade zonen och den anpassade WebPart kontrollen.

• En förklaring av hur exemplet fungerar.

Den första delen av kodexemplet innehåller källkod som skapar en enkel WebPart kontroll som visar text. För att kodexemplet ska köras måste du kompilera den här källkoden. Du kan kompilera den explicit och placera den resulterande sammansättningen i webbplatsens bin-mapp eller den globala sammansättningscacheminnet. Du kan också placera källkoden i webbplatsens App_Code mapp, där den kompileras dynamiskt vid körning. I det här kodexemplet används metoden för dynamisk kompilering. En genomgång som visar hur du kompilerar finns i Genomgång: Utveckla och använda en anpassad webbserverkontroll.

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

Den andra delen av exemplet innehåller källkod för att skapa den anpassade zonen och det anpassade WebPartVerb objektet. Observera att zonen åsidosätter OnCreateVerbs metoden för att lägga till det anpassade verbet i alla WebPart kontroller i zonen. Verbet läggs som standard till i verbmenyn i kontrollerna. Observera att konstruktorn för verbet i koden för det anpassade verbet använder en serverklickshanterare och att metoden som kallas skapar en fullständig kopia av alla kontroller som ärver direkt från WebPart klassen och lägger till den nyligen skapade kopian i samma zon. Precis som den första delen av kodexemplet måste den här källkoden kompileras, och i det här exemplet placerades källfilen i en App_Code undermapp som ska kompileras dynamiskt.

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

Den tredje delen av kodexemplet är webbsidan som är värd för kontrollerna. Observera att det finns ett Register direktiv längst upp på sidan för att deklarera namnområdet för de anpassade kontrollerna. Ingen sammansättning deklareras eftersom det här exemplet använder dynamisk kompilering. Den anpassade WebPart kontrollen deklareras i den anpassade zonen. Du kan också deklarera andra WebPart kontroller i den här zonen och det anpassade verbet skulle också läggas till i deras verbmenyer.

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

Läs in sidan i en webbläsare och klicka på verbmenyn på den anpassade WebPart kontrollen. Verbet Kopiera webbdel ska vara synligt. Klicka på verbet och observera att en kopia av kontrollen läggs till i zonen.

Kommentarer

Webbdelsverb är interaktiva gränssnittselement, som vanligtvis representeras av knappar eller hyperlänkar, som visas på sidor som använder kontroller för webbdelar. Användare klickar på verb för att utföra vanliga användargränssnittsåtgärder för webbdelskontroller, till exempel att stänga en WebPart kontroll eller stänga redigeringsvisningsläget (en särskild sidvy som är associerad med EditorZone kontrollen). Alla standardverb som tillhandahålls med kontrolluppsättningen Webbdelar är associerade med antingen en webbdelszon (, , eller ) eller en webbdelskontroll WebPartZone (EditorZone, CatalogZone, ConnectionsZoneeller Part).WebPartGenericWebPartEditorPartCatalogPart

När standardverb är associerade med en zon tillämpas deras åtgärder på zonnivå och verben visas vanligtvis i zonens sidhuvud- eller sidfotsområde. I följande tabell visas de vanliga verben på zonnivå och deras åtgärder beskrivs.

När det gäller standardverb som är associerade med Part kontroller gäller deras åtgärder för själva kontrollen (eller dess underordnade kontroller). Delkontrollen fungerar som en container för verbet och hanterar renderingen av verbet. De flesta standardverb som är associerade med delkontroller visas antingen direkt i namnlisten eller i en nedrullningsbar verbmeny i namnlisten. Om dessa verb visas direkt i rubriken eller i en verbmeny bestäms av WebPartVerbRenderMode egenskapen. Som standard visas verben i en verbmeny. I följande tabell visas vanliga verb som är associerade med de olika Part kontrollerna och beskriver deras åtgärder.

Tillsammans med standardverb som medföljer kontrolluppsättningen webbdelar kan du också skapa anpassade verb. Ett vanligt scenario för att skapa anpassade verb är att skapa verb som är associerade med Part kontroller. När du skapar dessa verb visas de som standard på verbmenyn tillsammans med standardverberna. Den grundläggande metoden för att skapa sådana verb är att ärva från WebPartVerb klassen för att skapa ett eller flera anpassade verb. Skapa sedan en kontroll som ärver från basklassen WebPart och lägg till anpassade WebPartVerb objekt i en WebPartVerbCollection samling. Den här samlingen kan sedan läggas till i Verbs kontrollens samling, vilket gör att de anpassade verben visas automatiskt på kontrollens verbmeny vid körning. Precis som med standardverb kan du komma åt anpassade verb programmatiskt på en WebPart kontroll.

Webbdelsprogram kan använda serverkontroller som inte ärver från klassen WebPart, till exempel anpassade kontroller, användarkontroller eller ASP.NET kontroller. Dessa serverkontroller, om de läggs till i en WebPartZoneBase zon, omsluts dynamiskt med ett GenericWebPart objekt vid körning, vilket gör att de kan fungera som körningskontroller WebPart . Om du vill lägga till anpassade verb i en serverkontroll som inte ärver från WebPart klassen måste serverkontrollen implementera IWebActionable gränssnittet och åsidosätta dess Verbs egenskap.

När du skapar ett verb kan du skapa två typer av associerade händelsehanterare som körs när en användare klickar på verbet: en händelsehanterare på serversidan (kod som körs på servern) och en händelsehanterare på klientsidan (kod som körs i klientwebbläsaren). Du kan också definiera anpassade tillstånd för verb, vilket är ett användbart sätt att ge visuella tips till användare. Du kan till exempel skapa ett tillstånd som anger att ett verb har valts och sedan ange lämpliga ändringar i användargränssnittet för att meddela användaren att verbet redan är valt. Ett annat användbart beteende är möjligheten att inaktivera verb. Genom att göra detta kan du hindra användare från att klicka på verb om det skulle vara skadligt eller ineffektivt baserat på programmets tillstånd.

Klassen WebPartVerb exponerar inga unika metoder. Dess exponerade metoder är alla åsidosättningar av basmetoder. Den innehåller dock ett antal egenskaper som utvecklare kan känna till. Egenskapen Checked anger om ett verb är valt för tillfället. Egenskaperna ClientClickHandler och ServerClickHandler refererar till respektive hanterare i klassen (om det finns några) för klient- och serverklickshändelser. Egenskapen Description innehåller text som beskriver syftet med ett verb i en knappbeskrivning när användarna placerar en muspekare över verbet i användargränssnittet. Egenskapen Enabled anger aktuell status för ett verb, som avgör om en användare kan klicka på verbet och köra åtgärden. Egenskapen ID ger ett unikt ID för verbobjektet. Egenskapen ImageUrl innehåller en URL till en bild som kan användas för att representera ett verb i användargränssnittet i stället för standardåtergivningen (vanligtvis en knapp eller en hyperlänk). Egenskapen Text innehåller etiketttexten som visas direkt på verbet i användargränssnittet. Den åsidosatta Visible egenskapen avgör om ett verb för närvarande visas i användargränssnittet. Verb döljs eller inaktiveras ofta vid olika tidpunkter i ett webbdelsprogram. Specialverb (till exempel redigeringsverb och anslutningsverb) visas till exempel bara när lämpliga kontroller, inställningar och visningslägen finns på sidan för att göra det möjligt för dessa verb att vidta meningsfulla åtgärder.

Andra viktiga medlemmar för att arbeta med verb är WebPartZoneBase.OnCreateVerbs metoden, som är en händelsehanterare som kan åsidosättas för anpassad hantering av verbskapandeprocessen och WebPartZoneBase.CreateVerbs händelsen.

Se även

• Verbs
• Verbs
• WebPartVerbCollection
• ASP.NET webbdelskontroller