WebPartVerb Třída

Definice

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

Dědičnost

Object

WebPartVerb

Atributy

TypeConverterAttribute

Implementuje

IStateManager

Příklady

Následující příklad kódu ukazuje, jak vytvořit vlastní WebPartVerb objekt a vlastní zónu, která používá metodu OnCreateVerbs k přidání příkazu do nabídky sloves každého WebPart ovládacího prvku obsaženého v zóně. Příklad kódu má čtyři části:

• Zdrojový soubor, který obsahuje jednoduchý vlastní WebPart ovládací prvek, který zobrazuje text.

• Zdrojový soubor, který obsahuje vlastní WebPartVerb objekt, a jednoduchou vlastní WebPartZoneBase zónu, která přepíše metodu OnCreateVerbs pro přidání vlastního příkazu do WebPart ovládacích prvků v zóně.

• Webová stránka, která obsahuje vlastní zónu a vlastní WebPart ovládací prvek.

• Vysvětlení, jak příklad funguje.

První část příkladu kódu obsahuje zdrojový kód, který vytvoří jednoduchý WebPart ovládací prvek, který zobrazí nějaký text. Aby se příklad kódu spustil, musíte tento zdrojový kód zkompilovat. Můžete ho explicitně zkompilovat a vložit výsledné sestavení do složky Bin webu nebo globální mezipaměti sestavení (GPA). Případně můžete zdrojový kód umístit do složky App_Code webu, kde se bude dynamicky kompilovat za běhu. Tento příklad kódu používá přístup dynamické kompilace. Návod, který ukazuje, jak kompilovat, najdete v tématu Návod: Vývoj a použití vlastního ovládacího prvku webového serveru.

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

Druhá část příkladu obsahuje zdrojový kód pro vytvoření vlastní zóny a vlastního WebPartVerb objektu. Všimněte si, že zóna přepíše metodu OnCreateVerbs pro přidání vlastního příkazu do všech WebPart ovládacích prvků v zóně. Příkaz je ve výchozím nastavení přidán do nabídky sloves ovládacích prvků. Všimněte si, že v kódu vlastního slovesa konstruktor pro příkaz používá obslužnou rutinu kliknutí na server a že metoda volaná vytvoří úplnou kopii libovolného ovládacího prvku, který dědí přímo z WebPart třídy, a přidá nově vytvořenou kopii do stejné zóny. Stejně jako v první části příkladu kódu musí být tento zdrojový kód zkompilován a v tomto příkladu byl zdrojový soubor umístěn do podsložky App_Code, aby se dynamicky zkompiloval.

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

Třetí částí příkladu kódu je webová stránka, která je hostitelem ovládacích prvků. Všimněte si, že v horní části stránky je Register direktiva, která deklaruje obor názvů vlastních ovládacích prvků. Není deklarováno žádné sestavení, protože tento příklad používá dynamickou kompilaci. Vlastní WebPart ovládací prvek je deklarován v rámci vlastní zóny. Můžete také deklarovat další WebPart ovládací prvky v této zóně a vlastní příkaz by se přidal také do jejich nabídek sloves.

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

Načtěte stránku v prohlížeči a klikněte na nabídku sloves ve vlastním WebPart ovládacím prvku. Příkaz Kopírovat webovou část by měl být viditelný. Klikněte na příkaz a všimněte si, že se do zóny přidá kopie ovládacího prvku.

Poznámky

Příkazy webových částí jsou interaktivní prvky uživatelského rozhraní, obvykle reprezentované tlačítky nebo hypertextovými odkazy, které se zobrazují na stránkách používajících ovládací prvky webových částí. Uživatelé kliknutím na příkazy provádějí běžné akce uživatelského rozhraní pro ovládací prvky webových částí, jako je zavření WebPart ovládacího prvku nebo zavření režimu zobrazení pro úpravy (speciální zobrazení stránky přidružené k ovládacímu EditorZone prvku). Všechny standardní příkazy, které jsou součástí sady ovládacích prvků webové části, jsou přidruženy buď k zóně webových částí (, , nebo ), nebo k ovládacímu prvku webové části Part (WebPart, GenericWebPart, EditorPartnebo CatalogPart).ConnectionsZoneCatalogZoneEditorZoneWebPartZone

Pokud jsou standardní příkazy přidruženy k zóně, jejich akce platí na úrovni zóny a příkazy se obvykle zobrazují v oblasti záhlaví nebo zápatí zóny. Následující tabulka uvádí společné příkazy na úrovni zóny a popisuje jejich akce.

Pokud jde o standardní příkazy, které jsou přidruženy k ovládacím prvkům Part , jejich akce platí pro samotný ovládací prvek (nebo pro jeho podřízené ovládací prvky). Ovládací prvek části funguje jako kontejner pro sloveso a spravuje vykreslování slovesa. Většina standardních sloves přidružených k ovládacím prvkům částí se zobrazí buď přímo v záhlaví, nebo v rozevírací nabídce sloves v záhlaví. To, jestli se tyto příkazy zobrazují přímo v záhlaví nebo v nabídce sloves, určuje WebPartVerbRenderMode vlastnost . Ve výchozím nastavení se příkazy zobrazují v nabídce sloves. Následující tabulka obsahuje seznam běžných sloves přidružených k různým Part ovládacím prvkům a popisuje jejich akce.

Spolu se standardními příkazy, které jsou součástí sady ovládacích prvků webové části, můžete také vytvářet vlastní příkazy. Běžným scénářem vytváření vlastních sloves je vytvoření sloves přidružených k ovládacím prvkům Part . Při vytváření těchto sloves se ve výchozím nastavení zobrazí v nabídce sloves spolu se standardními slovesy. Základním přístupem k vytváření takových sloves je dědění z WebPartVerb třídy a vytvoření jednoho nebo více vlastních sloves. Pak vytvořte ovládací prvek, který dědí ze WebPart základní třídy, a přidejte vlastní WebPartVerb objekty do WebPartVerbCollection kolekce. Tuto kolekci pak můžete přidat do Verbs kolekce ovládacího prvku, což způsobí, že se vlastní příkazy automaticky zobrazí v nabídce sloves ovládacího prvku za běhu. Stejně jako u standardních sloves můžete k vlastním slovesům přistupovat programově u WebPart ovládacího prvku.

Aplikace webových částí mohou používat serverové ovládací prvky, které nedědí WebPart z třídy, například vlastní ovládací prvky, uživatelské ovládací prvky nebo ASP.NET ovládací prvky. Tyto serverové ovládací prvky, pokud jsou přidány do WebPartZoneBase zóny, jsou dynamicky zabaleny s objektem GenericWebPart za běhu, což jim umožňuje fungovat jako ovládací prvky za běhu WebPart . Chcete-li přidat vlastní příkazy do ovládacího prvku serveru, který nedědí WebPart z třídy, serverový ovládací prvek musí implementovat IWebActionable rozhraní a přepsat jeho Verbs vlastnost.

Při vytváření příkazu můžete vytvořit dva typy přidružených obslužných rutin událostí, které se spustí, když uživatel klikne na příkaz: obslužnou rutinu události na straně serveru (kód, který běží na serveru) a obslužnou rutinu události na straně klienta (kód, který běží v klientském prohlížeči). Můžete také definovat vlastní stavy pro slovesa, což je užitečný způsob, jak uživatelům poskytnout vizuální upozornění. Můžete například vytvořit stav označující, že bylo vybráno sloveso, a pak v uživatelském rozhraní zadat příslušné změny, které uživatele upozorní, že je již vybráno. Dalším užitečným chováním je schopnost zakázat slovesa; tímto způsobem můžete uživatelům zabránit v kliknutí na příkazy, pokud by to bylo škodlivé nebo neúčinné v závislosti na stavu aplikace.

Třída WebPartVerb nezpřístupňuje žádné jedinečné metody; všechny její vystavené metody jsou přepsány základními metodami. Obsahuje ale řadu vlastností, o které musí vývojáři vědět. Vlastnost Checked označuje, jestli je aktuálně vybrána slovesa. Vlastnosti ClientClickHandler a ServerClickHandler odkazují na příslušné obslužné rutiny v rámci třídy (pokud existují) pro události kliknutí klienta a serveru. Vlastnost Description obsahuje text, který popisuje účel slovesa v popisu, když uživatelé umístí ukazatel myši na příkaz v uživatelském rozhraní. Vlastnost Enabled označuje aktuální stav slovesa, který určuje, zda uživatel může kliknout na příkaz a provést jeho akci. Vlastnost ID poskytuje jedinečné ID objektu slovesa. Vlastnost ImageUrl obsahuje adresu URL obrázku, která se dá použít k reprezentaci slovesa v uživatelském rozhraní místo výchozího vykreslování (obvykle tlačítka nebo hypertextového odkazu). Vlastnost Text obsahuje text popisku, který se zobrazí přímo na slovesu v uživatelském rozhraní. Přepsaná Visible vlastnost určuje, jestli se v uživatelském rozhraní aktuálně zobrazuje příkaz. Příkazy jsou často skryté nebo zakázané v různých časech v aplikaci webových částí; Například speciální slovesa (například upravit sloveso a spojení) se zobrazí pouze v případě, že na stránce existují příslušné ovládací prvky, nastavení a režimy zobrazení, které umožňují těmto slovesům provádět smysluplnou akci.

Mezi další klíčové členy pro práci s příkazy patří WebPartZoneBase.OnCreateVerbs metoda, což je obslužná rutina události, kterou lze přepsat pro vlastní zpracování procesu vytváření sloves, a WebPartZoneBase.CreateVerbs událost.

Konstruktory

Vlastnosti

Metody

Explicitní implementace rozhraní

Platí pro

Viz také

• Verbs
• Verbs
• WebPartVerbCollection
• ASP.NET ovládací prvky webových částí