WebPartVerb Класс

Определение

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

Наследование

Object

WebPartVerb

Атрибуты

TypeConverterAttribute

Реализации

IStateManager

Примеры

В следующем примере кода показано, как создать пользовательский WebPartVerb объект и пользовательскую зону, которая использует OnCreateVerbs метод для добавления команды в меню команд каждого WebPart элемента управления, содержащегося в зоне. В примере кода есть четыре части:

• Исходный файл, содержащий простой пользовательский WebPart элемент управления, отображающий некоторый текст.

• Исходный файл, содержащий пользовательский WebPartVerb объект, и простую пользовательскую WebPartZoneBase зону, переопределив OnCreateVerbs метод для добавления пользовательской команды в WebPart элементы управления в зоне.

• Веб-страница, содержащая пользовательскую зону и пользовательский WebPart элемент управления.

• Объяснение того, как работает пример.

Первая часть примера кода содержит исходный код, который создает простой WebPart элемент управления, отображающий некоторый текст. Для запуска примера кода необходимо скомпилировать этот исходный код. Вы можете скомпилировать его явным образом и поместить полученную сборку в папку bin веб-сайта или глобальный кэш сборок. Кроме того, исходный код можно поместить в папку App_Code сайта, где он будет динамически скомпилирован во время выполнения. В этом примере кода используется подход динамической компиляции. Пошаговое руководство по компиляции см. в руководстве по разработке и использованию пользовательского веб-сервера.

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

Вторая часть примера содержит исходный код для создания пользовательской зоны и пользовательского WebPartVerb объекта. Обратите внимание, что зона переопределяет OnCreateVerbs метод, чтобы добавить пользовательскую команду к любым WebPart элементам управления в зоне. Команда добавляется по умолчанию в меню команд элементов управления. Обратите внимание, что в коде для пользовательской команды конструктор для команды использует обработчик щелчка сервера, и что метод, называемый методом, создает полную копию любого элемента управления, наследуемого непосредственно от WebPart класса, добавив только что созданную копию в ту же зону. Как и первая часть примера кода, этот исходный код должен быть скомпилирован, и в этом примере исходный файл был помещен в вложенную папку App_Code для динамической компиляции.

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

Третья часть примера кода — веб-страница, на которую размещаются элементы управления. Обратите внимание, что в верхней части страницы есть Register директива, которая будет объявлять пространство имен пользовательских элементов управления. Сборка не объявлена, так как в этом примере используется динамическая компиляция. Настраиваемый WebPart элемент управления объявлен в пользовательской зоне. Вы также можете объявить другие WebPart элементы управления в этой зоне, а пользовательская команда также будет добавлена в их меню команд.

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

Загрузите страницу в браузере и выберите меню команд в пользовательском WebPart элементе управления. Глагол веб-части копирования должен быть видимым. Щелкните команду и обратите внимание, что копия элемента управления добавляется в зону.

Комментарии

Команды веб-частей — это интерактивные элементы пользовательского интерфейса, обычно представленные кнопками или гиперссылками, которые отображаются на страницах, использующих элементы управления веб-частей. Пользователи щелкают команды для выполнения общих действий пользовательского интерфейса для элементов управления веб-частей, таких как закрытие WebPart элемента управления или закрытие режима отображения редактирования (специальное представление страницы, связанное с элементом EditorZone управления). Все стандартные команды, предоставляемые набором элементов управления веб-частей, связаны либо с зоной веб-частей (, EditorZoneCatalogZoneили) либо ConnectionsZoneэлементом управления веб-частей Part (WebPartZoneWebPart, или).CatalogPartGenericWebPartEditorPart

Когда стандартные команды связаны с зоной, их действия применяются на уровне зоны, а команды обычно отображаются в области верхнего или нижнего колонтитула зоны. В следующей таблице перечислены общие команды уровня зоны и описываются их действия.

Что касается стандартных команд, связанных с Part элементами управления, их действия применяются к самому элементу управления (или к его дочерним элементам управления). Элемент управления частью выступает в качестве контейнера для команды и управляет отрисовкой команды. Большинство стандартных команд, связанных с элементами управления частью, отображаются непосредственно в строке заголовка или в раскрывающемся меню команд в строке заголовка. Независимо от того, отображаются ли эти команды непосредственно в заголовке или в меню команд определяются WebPartVerbRenderMode свойством. По умолчанию команды отображаются в меню команд. В следующей таблице перечислены распространенные команды, связанные с различными Part элементами управления, и описываются их действия.

Наряду со стандартными командами, предоставляемыми набором элементов управления веб-частей, можно также создавать пользовательские команды. Распространенный сценарий создания пользовательских команд — создание команд, связанных с Part элементами управления. При создании этих команд по умолчанию они будут отображаться в меню команд вместе со стандартными командами. Базовый подход к созданию таких команд заключается в наследовании от WebPartVerb класса для создания одной или нескольких пользовательских команд. Затем создайте элемент управления, наследуемый от WebPart базового класса, и добавьте пользовательские WebPartVerb объекты в коллекцию WebPartVerbCollection . Затем эту коллекцию можно добавить Verbs в коллекцию элемента управления, что приведет к автоматическому отображению пользовательских команд в меню команд элемента управления во время выполнения. Как и в стандартных командах, вы можете получить доступ к пользовательским командам программным способом в элементе WebPart управления.

Приложения веб-частей могут использовать серверные элементы управления, которые не наследуются от WebPart класса, например пользовательские элементы управления, пользовательские элементы управления или элементы управления ASP.NET. Эти серверные элементы управления, если они добавляются WebPartZoneBase в зону, динамически упаковываются в GenericWebPart объект во время выполнения, что позволяет им функционировать как элементы управления во время WebPart выполнения. Чтобы добавить пользовательские команды в серверный элемент управления, который не наследует от WebPart класса, серверный элемент управления должен реализовать IWebActionable интерфейс и переопределить его Verbs свойство.

При создании команды можно создать два типа связанных обработчиков событий, которые будут выполняться, когда пользователь щелкает команду: обработчик событий на стороне сервера (код, выполняемый на сервере), а также обработчик событий на стороне клиента (код, который выполняется в клиентском браузере). Кроме того, можно определить пользовательские состояния для команд, что удобно для предоставления визуальных подсказок пользователям. Например, можно создать состояние, указывающее, что выбрана команда, а затем указать соответствующие изменения в пользовательском интерфейсе, чтобы уведомить пользователя о том, что команда уже выбрана. Другое полезное поведение — возможность отключить команды; Таким образом, вы можете запретить пользователям щелкнуть команды, если это будет вредно или неэффективно в зависимости от состояния приложения.

Класс WebPartVerb не предоставляет уникальные методы; его предоставляемые методы являются переопределениями базовых методов. Однако он содержит ряд свойств, о которых разработчики должны знать. Свойство Checked указывает, выбрана ли в данный момент команда. ServerClickHandler Свойства ClientClickHandler относятся к соответствующим обработчикам в классе (если таковые существуют) для событий щелчка клиента и сервера. Свойство Description содержит текст, описывающий назначение команды в подсказке при расположении указателя мыши на команду в пользовательском интерфейсе. Свойство Enabled указывает текущее состояние команды, которая определяет, может ли пользователь щелкнуть команду и выполнить его действие. Свойство ID предоставляет уникальный идентификатор объекта команды. Свойство ImageUrl содержит URL-адрес изображения, который можно использовать для представления команды в пользовательском интерфейсе вместо отрисовки по умолчанию (обычно кнопки или гиперссылки). Свойство Text содержит текст метки, который отображается непосредственно в команде в пользовательском интерфейсе. Переопределенное Visible свойство определяет, отображается ли в пользовательском интерфейсе команда. Команды часто скрыты или отключены в разное время в приложении веб-частей; Например, специальные команды (например, редактируемая команда и команда подключения) отображаются только в том случае, если на странице существуют соответствующие элементы управления, параметры и режимы отображения, чтобы эти команды могли выполнять значимые действия.

Другие ключевые члены для работы с командами включают WebPartZoneBase.OnCreateVerbs метод, который является обработчиком событий, который можно переопределить для пользовательской обработки процесса создания команды и WebPartZoneBase.CreateVerbs события.

См. также раздел

• Verbs
• Verbs
• WebPartVerbCollection
• элементы управления веб-частей ASP.NET