WebPartVerb Klas

Definitie

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

Overname

Object

WebPartVerb

Kenmerken

TypeConverterAttribute

Implementeringen

IStateManager

Voorbeelden

In het volgende codevoorbeeld ziet u hoe u een aangepast WebPartVerb object maakt en een aangepaste zone die gebruikmaakt van de OnCreateVerbs methode om het werkwoord toe te voegen aan het menu werkwoorden van elk WebPart besturingselement in de zone. Er zijn vier onderdelen voor het codevoorbeeld:

• Een bronbestand met een eenvoudig aangepast besturingselement WebPart dat tekst weergeeft.

• Een bronbestand dat een aangepast WebPartVerb object bevat en een eenvoudige aangepaste WebPartZoneBase zone die de OnCreateVerbs methode overschrijft om het aangepaste werkwoord toe te voegen aan WebPart besturingselementen in de zone.

• Een webpagina met de aangepaste zone en het aangepaste besturingselement WebPart .

• Een uitleg van hoe het voorbeeld werkt.

Het eerste deel van het codevoorbeeld bevat broncode waarmee een eenvoudig WebPart besturingselement wordt gemaakt waarin tekst wordt weergegeven. Als u het codevoorbeeld wilt uitvoeren, moet u deze broncode compileren. U kunt deze expliciet compileren en de resulterende assembly in de map Bin van uw website of de globale assemblycache plaatsen. U kunt de broncode ook in de map App_Code van uw site plaatsen, waar deze dynamisch wordt gecompileerd tijdens runtime. In dit codevoorbeeld wordt de dynamische compilatiebenadering gebruikt. Zie Walkthrough: Een aangepast webserverbeheer ontwikkelen en gebruiken voor een overzicht van hoe u compileert.

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

Het tweede deel van het voorbeeld bevat broncode om de aangepaste zone en het aangepaste WebPartVerb object te maken. Houd er rekening mee dat de zone de OnCreateVerbs methode overschrijft om het aangepaste werkwoord toe te voegen aan besturingselementen WebPart in de zone. Het werkwoord wordt standaard toegevoegd aan het menu werkwoorden van de besturingselementen. Houd er rekening mee dat in de code voor het aangepaste werkwoord de constructor voor het werkwoord een serverklikhandler gebruikt en dat de methode die wordt aangeroepen, een volledige kopie maakt van een besturingselement dat rechtstreeks van de WebPart klasse overgaat en de zojuist gemaakte kopie toevoegt aan dezelfde zone. Net als het eerste deel van het codevoorbeeld moet deze broncode worden gecompileerd en in dit voorbeeld is het bronbestand in een App_Code submap geplaatst om dynamisch te worden gecompileerd.

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

Het derde deel van het codevoorbeeld is de webpagina waarop de besturingselementen worden gehost. Houd er rekening mee dat er boven aan de pagina een Register instructie is om de naamruimte van de aangepaste besturingselementen te declareren. Er wordt geen assembly gedeclareerd omdat in dit voorbeeld dynamische compilatie wordt gebruikt. Het aangepaste WebPart besturingselement wordt gedeclareerd binnen de aangepaste zone. U kunt ook andere WebPart besturingselementen in deze zone declareren en het aangepaste werkwoord wordt ook toegevoegd aan hun werkwoordmenu's.

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

Laad de pagina in een browser en klik op het menu Werkwoorden in het aangepaste WebPart besturingselement. De bewerking Webonderdeel Kopiëren moet zichtbaar zijn. Klik op het werkwoord en houd er rekening mee dat er een kopie van het besturingselement wordt toegevoegd aan de zone.

Opmerkingen

Webonderdelenwerkwoorden zijn interactieve UI-elementen, meestal vertegenwoordigd door knoppen of hyperlinks, die worden weergegeven op pagina's die gebruikmaken van besturingselementen voor webonderdelen. Gebruikers klikken op werkwoorden om algemene UI-acties uit te voeren voor besturingselementen voor webonderdelen, zoals het sluiten van een WebPart besturingselement of het sluiten van de bewerkingsweergavemodus (een speciale paginaweergave die is gekoppeld aan het EditorZone besturingselement). Alle standaardwerkwoorden die worden geleverd met de besturingsset webonderdelen, zijn gekoppeld aan een zone met webonderdelen (, , of ) of een besturingselement voor webonderdelen Part (WebPart, GenericWebPart, EditorPartof CatalogPart).ConnectionsZoneCatalogZoneEditorZoneWebPartZone

Wanneer de standaardwoorden aan een zone zijn gekoppeld, worden de bijbehorende acties toegepast op zoneniveau en worden de werkwoorden meestal weergegeven in het kop- of voettekstgebied van de zone. De volgende tabel bevat de algemene werkwoorden op zoneniveau en beschrijft de bijbehorende acties.

Wat betreft de standaardwoorden die zijn gekoppeld aan Part besturingselementen, zijn hun acties van toepassing op het besturingselement zelf (of op de onderliggende besturingselementen). Het onderdeelbeheer fungeert als een container voor het werkwoord en beheert het weergeven van het werkwoord. De meeste standaardwerkwoorden die zijn gekoppeld aan onderdeelbesturingselementen, worden rechtstreeks op de titelbalk of in een vervolgkeuzelijst in de titelbalk weergegeven. Of deze werkwoorden nu rechtstreeks in de koptekst of in een menu werkwoorden worden weergegeven, wordt bepaald door de WebPartVerbRenderMode eigenschap. Standaard worden de werkwoorden weergegeven in een menu met werkwoorden. De volgende tabel bevat veelgebruikte werkwoorden die zijn gekoppeld aan de verschillende Part besturingselementen en beschrijft hun acties.

Naast de standaardwerkwoorden die worden geleverd met de besturingsset webonderdelen, kunt u ook aangepaste werkwoorden maken. Een veelvoorkomend scenario voor het maken van aangepaste werkwoorden is het maken van werkwoorden die zijn gekoppeld aan Part besturingselementen. Wanneer u deze werkwoorden maakt, worden deze standaard weergegeven in het menu werkwoorden, samen met de standaardwerkwoorden. De basisbenadering voor het maken van dergelijke werkwoorden is het overnemen van de WebPartVerb klasse om een of meer aangepaste werkwoorden te maken. Maak vervolgens een besturingselement dat wordt overgenomen van de WebPart basisklasse en voeg de aangepaste WebPartVerb objecten toe aan een WebPartVerbCollection verzameling. Deze verzameling kan vervolgens worden toegevoegd aan de Verbs verzameling van het besturingselement, waardoor de aangepaste werkwoorden automatisch worden weergegeven in het menu werkwoorden van het besturingselement tijdens runtime. Net als bij de standaardwoorden hebt u programmatisch toegang tot de aangepaste werkwoorden op een WebPart besturingselement.

Webonderdelentoepassingen kunnen serverbesturingselementen gebruiken die niet overnemen van de klasse WebPart, zoals aangepaste besturingselementen, gebruikersbesturingselementen of ASP.NET besturingselementen. Deze serverbesturingselementen, indien toegevoegd aan een WebPartZoneBase zone, worden dynamisch verpakt met een GenericWebPart object tijdens runtime, waardoor ze kunnen functioneren als runtime-besturingselementen WebPart . Als u aangepaste werkwoorden wilt toevoegen aan een serverbesturingselement dat niet van de WebPart klasse overneemt, moet het serverbesturingselement de interface implementeren en de IWebActionable eigenschap ervan overschrijven Verbs .

Wanneer u een werkwoord maakt, kunt u twee typen gekoppelde gebeurtenis-handlers maken die worden uitgevoerd wanneer een gebruiker op het werkwoord klikt: een gebeurtenis-handler aan de serverzijde (code die op de server wordt uitgevoerd) en een gebeurtenis-handler aan de clientzijde (code die in de clientbrowser wordt uitgevoerd). U kunt ook aangepaste statussen definiëren voor werkwoorden. Dit is een handige manier om visuele aanwijzingen aan gebruikers te bieden. U kunt bijvoorbeeld een status maken die aangeeft dat een werkwoord is geselecteerd en vervolgens de juiste wijzigingen in de gebruikersinterface opgeven om de gebruiker op de hoogte te stellen dat het werkwoord al is geselecteerd. Een ander nuttig gedrag is de mogelijkheid om werkwoorden uit te schakelen; Door dit te doen, kunt u voorkomen dat gebruikers klikken op werkwoorden als dit schadelijk of ineffectief zou zijn op basis van de status van de toepassing.

De klasse biedt geen unieke methoden. De WebPartVerb weergegeven methoden zijn allemaal onderdrukkingen van basismethoden. Het bevat echter een aantal eigenschappen waar ontwikkelaars rekening mee moeten houden. De Checked eigenschap geeft aan of een werkwoord momenteel is geselecteerd. De ClientClickHandler en ServerClickHandler eigenschappen verwijzen naar de respectieve handlers binnen de klasse (indien aanwezig) voor client- en serverklikken op gebeurtenissen. De Description eigenschap bevat tekst die het doel van een werkwoord in een Knopinfo beschrijft wanneer gebruikers een muisaanwijzer op het werkwoord in de gebruikersinterface plaatsen. De Enabled eigenschap geeft de huidige status van een werkwoord aan, waarmee wordt bepaald of een gebruiker op het werkwoord kan klikken en de actie kan uitvoeren. De ID eigenschap biedt een unieke id voor het werkwoordobject. De ImageUrl eigenschap bevat een URL naar een afbeelding die kan worden gebruikt om een werkwoord in de gebruikersinterface weer te geven in plaats van de standaardweergave (meestal een knop of hyperlink). De Text eigenschap bevat de labeltekst die rechtstreeks op het werkwoord in de gebruikersinterface wordt weergegeven. De overschreven Visible eigenschap bepaalt of een werkwoord momenteel wordt weergegeven in de gebruikersinterface. Werkwoorden worden vaak verborgen of uitgeschakeld op verschillende tijdstippen in een webonderdelentoepassing; Speciale werkwoorden (zoals het bewerkingswerkwoord en het verbindingswerkwoord) worden bijvoorbeeld alleen weergegeven wanneer de juiste besturingselementen, instellingen en weergavemodi op de pagina bestaan, zodat deze werkwoorden zinvolle actie kunnen ondernemen.

Andere belangrijke leden voor het werken met werkwoorden zijn de WebPartZoneBase.OnCreateVerbs methode, een gebeurtenis-handler die kan worden overschreven voor aangepaste verwerking van het proces voor het maken van werkwoorden en de WebPartZoneBase.CreateVerbs gebeurtenis.

Zie ook

• Verbs
• Verbs
• WebPartVerbCollection
• ASP.NET besturingselementen voor webonderdelen