WebPartVerb Класс

Определение

Предоставляет элемент интерактивного пользовательского интерфейса, который позволяет пользователям выполнять действия на странице веб-частей.Provides an interactive user interface (UI) element that enables users to perform actions on a Web Parts page.

public ref class WebPartVerb : System::Web::UI::IStateManager
[System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.EmptyStringExpandableObjectConverter))]
public class WebPartVerb : System.Web.UI.IStateManager
type WebPartVerb = class
    interface IStateManager
Public Class WebPartVerb
Implements IStateManager
Наследование
WebPartVerb
Атрибуты
Реализации

Примеры

В следующем примере кода показано, как создать пользовательский WebPartVerb объект и пользовательскую зону, которая OnCreateVerbs использует метод для добавления команды в меню команд каждого WebPart элемента управления, содержащегося в зоне.The following code example shows how to create a custom WebPartVerb object, and a custom zone that uses the OnCreateVerbs method to add the verb to the verbs menu of each WebPart control contained in the zone. Пример кода состоит из четырех частей:There are four parts to the code example:

  • Исходный файл, содержащий простой пользовательский WebPart элемент управления, отображающий некоторый текст.A source file that contains a simple custom WebPart control that displays some text.

  • Исходный файл WebPartVerb , содержащий пользовательский объект, и простая пользовательская WebPartZoneBase зона, которая переопределяет OnCreateVerbs метод для добавления пользовательской команды к WebPart элементам управления в зоне.A source file that contains a custom WebPartVerb object, and a simple custom WebPartZoneBase zone that overrides the OnCreateVerbs method to add the custom verb to WebPart controls in the zone.

  • Веб-страница, содержащая пользовательскую зону и пользовательский WebPart элемент управления.A Web page that contains the custom zone and the custom WebPart control.

  • Описание работы этого примера.An explanation of how the example works.

В первой части примера кода содержится исходный код, который создает простой WebPart элемент управления, отображающий некоторый текст.The first part of the code example contains source code that creates a simple WebPart control that displays some text. Для выполнения примера кода необходимо скомпилировать этот исходный код.For the code example to run, you must compile this source code. Его можно скомпилировать явным образом и разместить полученную сборку в папке Bin веб-сайта или в глобальном кэше сборок.You can compile it explicitly and put the resulting assembly in your Web site's Bin folder or the global assembly cache. Кроме того, можно разместить исходный код в папке App_Code сайта, где он будет динамически компилироваться во время выполнения.Alternatively, you can put the source code in your site's App_Code folder, where it will be dynamically compiled at run time. В этом примере кода используется метод динамической компиляции.This code example uses the dynamic compilation approach. Пошаговое руководство, в котором демонстрируется компиляция , см. в разделе Пошаговое руководство. Разработка и использование пользовательского серверного веб-элемента управления.For a walkthrough that demonstrates how to compile, see Walkthrough: Developing and Using a Custom Web Server Control.

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 объекта.The second part of the example contains source code to create the custom zone and the custom WebPartVerb object. Обратите внимание, что зона OnCreateVerbs переопределяет метод, чтобы добавить пользовательскую WebPart команду в любые элементы управления в зоне.Note that the zone overrides the OnCreateVerbs method to add the custom verb to any WebPart controls in the zone. Команда добавляется по умолчанию в меню команд элементов управления.The verb is added by default to the verbs menu of the controls. Обратите внимание, что в коде для пользовательской команды конструктор для команды использует обработчик щелчка сервера, а метод, вызываемый, создает полную копию любого элемента управления, наследующего непосредственно от WebPart класса, добавляя созданную копию в ту же зону.Note that, in the code for the custom verb, the constructor for the verb uses a server click handler, and that the method called creates a complete copy of any control that inherits directly from the WebPart class, adding the newly created copy to the same zone. Как и в первой части примера кода, этот исходный код должен быть скомпилирован, а в этом примере исходный файл был помещен в подпапку App_Code для динамической компиляции.Like the first part of the code example, this source code must be compiled, and in this example the source file was placed in an App_Code subfolder to be dynamically compiled.

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

Третья часть примера кода — это веб-страница, на которой размещены элементы управления.The third part of the code example is the Web page that hosts the controls. Обратите внимание, что Register в верхней части страницы есть директива для объявления пространства имен пользовательских элементов управления.Note that there is a Register directive near the top of the page to declare the namespace of the custom controls. Сборка не объявлена, так как в этом примере используется динамическая компиляция.No assembly is declared because this example uses dynamic compilation. Пользовательский WebPart элемент управления объявляется в пользовательской зоне.The custom WebPart control is declared within the custom zone. Можно также объявить другие WebPart элементы управления в этой зоне, а пользовательская команда будет добавлена и в меню команд.You could also declare other WebPart controls in this zone, and the custom verb would be added to their verbs menus as well.

<%@ 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 элементе управления.Load the page in a browser, and click the verbs menu on the custom WebPart control. Команда Копировать веб-часть должна быть видимой.The Copy Web Part verb should be visible. Щелкните команду и обратите внимание, что копия элемента управления добавляется в зону.Click the verb, and note that a copy of the control is added to the zone.

Комментарии

Веб-части глаголы — это интерактивные элементы пользовательского интерфейса, обычно представленные кнопками или гиперссылками, которые отображаются на страницах, использующих элементы управления веб-части.Web Parts verbs are interactive UI elements, typically represented by buttons or hyperlinks, that appear in pages that use Web Parts controls. Пользователи щелкают команды для выполнения общих действий пользовательского интерфейса для элементов управления веб-части, таких как закрытие WebPart элемента управления или закрытие режима отображения редактирования (специальное представление страницы, EditorZone связанное с элементом управления).Users click verbs to carry out common UI actions for Web Parts controls, such as closing a WebPart control or closing the edit display mode (a special page view associated with the EditorZone control). Все стандартные команды, поставляемые с набором элементов управления веб-части, связаны с зоной веб-части (WebPartZone CatalogZone, EditorZone, или ConnectionsZone) или с элементом управления Part веб-части (WebPart, GenericWebPart, EditorPart, илиCatalogPart).All standard verbs provided with the Web Parts control set are associated with either a Web Parts zone (WebPartZone, EditorZone, CatalogZone, or ConnectionsZone) or a Web Parts Part control (WebPart, GenericWebPart, EditorPart, or CatalogPart).

Если стандартные команды связаны с зоной, их действия применяются на уровне зоны, а глаголы обычно отображаются в области верхнего или нижнего колонтитула зоны.When the standard verbs are associated with a zone, their actions apply at the zone level, and the verbs usually appear in the zone's header or footer area. В следующей таблице перечислены распространенные команды уровня зоны и описаны их действия.The following table lists the common zone-level verbs and describes their actions.

Команда уровня зоныZone-level verb ДействиеAction
Команда закрытияClose verb Используется с зонами, которые наследуются от ToolZone класса.Used with zones that inherit from the ToolZone class. Скрывает пользовательский интерфейс для зоны и обычно возвращает страницу в обычное представление режима просмотра.Hides the UI for a zone and typically returns the page to its normal browse mode view.
Применить командуApply verb Используется с зонами, которые наследуются от EditorZoneBase класса.Used with zones that inherit from the EditorZoneBase class. Применяет изменения, внесенные пользователем.Applies changes that a user has made.
Команда "ОК"OK verb Используется с зонами, которые наследуются от EditorZoneBase класса.Used with zones that inherit from the EditorZoneBase class. Имеет Объединенный результат команд Apply и Close; Он применяет изменения и скрывает пользовательский интерфейс зоны.Has the combined effect of the apply and close verbs; it applies changes and hides the zone's UI.
Команда отменыCancel verb Используется с зонами, которые наследуются от ToolZone класса.Used with zones that inherit from the ToolZone class. Отменяет все ожидающие изменения, внесенные пользователем.Cancels any pending changes a user has made.
Добавить командуAdd verb Используется с зонами, которые наследуются от CatalogZoneBase класса.Used with zones that inherit from the CatalogZoneBase class. Добавляет элемент управления, выбранный пользователем из каталога элементов управления в указанную WebPartZone зону.Adds a control that a user has selected from a catalog of controls to a specified WebPartZone zone.
Команда настройкиConfigure verb Используется с зонами, которые наследуются от ConnectionsZone класса.Used with zones that inherit from the ConnectionsZone class. Открывает представление, чтобы разрешить пользователям настраивать существующие подключения.Opens a view to enable users to configure existing connections.
Команда отключенияDisconnect verb Используется с зонами, которые наследуются от ConnectionsZone класса.Used with zones that inherit from the ConnectionsZone class. Завершает существующее соединение между двумя элементами управления.Terminates an existing connection between two controls.

Как и для стандартных команд, связанных с Part элементами управления, их действия применяются к самому элементу управления (или к его дочерним элементам управления).As for the standard verbs that are associated with Part controls, their actions apply to the control itself (or to its child controls). Элемент управления "часть" выступает в качестве контейнера для команды и управляет отрисовкой команды.The part control acts as a container for the verb and manages the rendering of the verb. Большинство стандартных команд, связанных с элементами управления "часть", появляются либо непосредственно в заголовке окна, либо в меню команд раскрывающегося списка в заголовке окна.Most standard verbs associated with part controls appear either directly in the title bar or in a drop-down verbs menu within the title bar. Указывает, отображаются ли эти команды непосредственно в заголовке или в меню WebPartVerbRenderMode команд. по умолчанию команды отображаются в меню команд.Whether these verbs appear directly in the header or in a verbs menu is determined by the WebPartVerbRenderMode property; by default, the verbs appear in a verbs menu. В следующей таблице перечислены распространенные команды, связанные с различными Part элементами управления, и описываются их действия.The following table lists common verbs associated with the various Part controls and describes their actions.

Команда управления частейPart control verb ДействиеAction
Команда сворачиванияMinimize verb Отображается в меню команд каждого серверного элемента управления, содержащегося в WebPartZoneBase зоне.Appears in the verbs menu of each server control contained in a WebPartZoneBase zone. Сокращает элемент управления до минимального представления, скрывая все в пользовательском интерфейсе, за исключением команды Restore.Reduces the control to a minimal representation, hiding everything in its UI except the restore verb.
Команда RestoreRestore verb Отображается в меню команд каждого серверного элемента управления, содержащегося в WebPartZoneBase зоне.Appears in the verbs menu of each server control contained in a WebPartZoneBase zone. Возвращает уменьшенный элемент управления до его обычного размера и представления.Returns a minimized control to its normal size and view.
Команда закрытияClose verb Отображается в меню команд каждого серверного элемента управления, содержащегося в WebPartZoneBase зоне.Appears in the verbs menu of each server control contained in a WebPartZoneBase zone. Закрывает элемент управления и добавляет его в каталог страниц. Это означает, что элемент управления удаляется из страницы, но при наличии правильно спроектированного каталога пользователи могут повторно открыть закрытый элемент управления и вернуть его на страницу.Closes a control and adds it to the page catalog, which means the control is removed from the page but, if there is a properly designed catalog, users can reopen the closed control and return it to the page.
Команда подключенияConnect verb Отображается в меню команд элемента управления, содержащегося в WebPartZoneBase зоне, если страница находится в режиме отображения соединения и если элемент управления может формировать подключения.Appears in the verbs menu of a control contained in a WebPartZoneBase zone, if the page is in connect display mode and if the control can form connections. Открывает пользовательский интерфейс подключения, чтобы пользователи могли создавать подключения между элементами управления.Opens a connection UI so that users can create a connection between controls.
Команда удаленияDelete verb Отображается в меню команд элемента управления, содержащегося в WebPartZoneBase зоне, если элемент управления был добавлен на страницу программным способом (вместо того, чтобы объявляться в формате сохраняемости).Appears in the verbs menu of a control contained in a WebPartZoneBase zone, if the control was added to the page programmatically (rather than being declared in persistence format). Окончательно удаляет экземпляр элемента управления и все связанные данные персонализации, поэтому, в отличие от закрытого элемента управления, удаленный экземпляр не может быть восстановлен на странице.Permanently deletes the control instance and any associated personalization data so that, unlike a closed control, the deleted instance can never be restored to the page.
Изменить командуEdit verb Отображается в меню команд элемента управления, содержащегося в WebPartZoneBase зоне, если страница разрешается изменять элементы управления и если страница находится в режиме отображения редактирования.Appears in the verbs menu of a control contained in a WebPartZoneBase zone, if the page is designed to permit editing of controls and if the page is in edit display mode. Выбирает элемент управления для редактирования и открывает пользовательский интерфейс редактирования.Selects the control for editing and opens the editing UI.
Команда экспортаExport verb Отображается в меню команд элемента управления, содержащегося в WebPartZoneBase зоне, если элемент управления и приложение включены для экспорта.Appears in the verbs menu of a control contained in a WebPartZoneBase zone, if the control and application are enabled for export. Открывает диалоговое окно, позволяющее пользователям экспортировать файл описания, содержащий сериализованное состояние элемента управления.Opens a dialog box that enables users to export a description file that contains the serialized state of the control. Дополнительные сведения см. в свойстве ExportMode.For details, see the ExportMode property.
Команда справкиHelp verb Отображается в меню команд элемента управления, содержащегося в WebPartZoneBase зоне, если элемент управления предназначен для предоставления файла справки.Appears in the verbs menu of a control contained in a WebPartZoneBase zone, if the control is designed to provide a Help file. Запускает страницу, которая предоставляет справку для элемента управления.Launches a page that provides help for the control.

Наряду с стандартными командами, поставляемыми с набором элементов управления веб-части, можно также создавать пользовательские команды.Along with the standard verbs that are provided with the Web Parts control set, you can also create custom verbs. Распространенным сценарием создания пользовательских команд является создание команд, связанных с Part элементами управления.A common scenario for creating custom verbs is to create verbs associated with Part controls. При создании этих команд по умолчанию они будут отображаться в меню команд вместе со стандартными командами.When you create these verbs, by default they will appear on the verbs menu along with the standard verbs. Базовый подход к созданию таких команд заключается в наследовании от WebPartVerb класса для создания одной или нескольких пользовательских команд.The basic approach for creating such verbs is to inherit from the WebPartVerb class to create one or more custom verbs. Затем создайте элемент управления, наследующий от WebPart базового класса, и добавьте пользовательские WebPartVerb объекты в WebPartVerbCollection коллекцию.Then create a control that inherits from the WebPart base class and add the custom WebPartVerb objects to a WebPartVerbCollection collection. Затем эту коллекцию можно добавить в Verbs коллекцию элемента управления, что приведет к автоматическому отображению пользовательских команд в меню команд элемента управления во время выполнения.This collection can then be added to the Verbs collection of the control, which will cause the custom verbs to appear automatically on the control's verbs menu at run time. Как и в случае со стандартными командами, вы можете получить доступ к пользовательским WebPart командам в элементе управления программным способом.As with the standard verbs, you can access the custom verbs programmatically on a WebPart control.

Веб-части приложения могут использовать серверные элементы управления, которые не наследуются от WebPart класса, например пользовательские элементы управления, пользовательские элементы управления или элементы управления ASP.NET.Web Parts applications can use server controls that do not inherit from the WebPart class, such as custom controls, user controls, or ASP.NET controls. Эти серверные элементы управления, добавленные WebPartZoneBase в зону, динамически упаковываются GenericWebPart вместе с объектом во время выполнения, что позволяет им работать как элементы управления времени WebPart выполнения.These server controls, if added to a WebPartZoneBase zone, are dynamically wrapped with a GenericWebPart object at run time, which enables them to function as run-time WebPart controls. Чтобы добавить пользовательские команды в серверный элемент управления, который не наследуется WebPart от класса, серверный элемент управления должен IWebActionable реализовать интерфейс и переопределить Verbs его свойство.To add custom verbs to a server control that does not inherit from the WebPart class, the server control must implement the IWebActionable interface and override its Verbs property.

При создании команды можно создать два типа связанных обработчиков событий, которые будут выполняться, когда пользователь щелкнет команду: обработчик событий на стороне сервера (код, выполняемый на сервере) и обработчик событий на стороне клиента (код, который выполняется в клиентском браузере).When you create a verb, you can create two types of associated event handlers that will run when a user clicks the verb: a server-side event handler (code that runs on the server), and a client-side event handler (code that runs in the client browser). Кроме того, можно определить пользовательские состояния для команд, что является удобным способом предоставления пользователям визуальных подсказок.Also, you can define custom states for verbs, which is a useful way to provide visual cues to users. Например, можно создать состояние, указывающее, что выбрана команда, а затем предоставить соответствующие изменения в пользовательском интерфейсе, чтобы уведомить пользователя о том, что команда уже выбрана.For example, you could create a state indicating that a verb has been selected, and then provide appropriate changes in the UI to notify the user that the verb is already selected. Другое полезное поведение — возможность отключения команд. Таким образом, можно запретить пользователям щелкать команды, если это может быть опасно или неэффективным в зависимости от состояния приложения.Another useful behavior is the ability to disable verbs; by doing this, you can prevent users from clicking verbs if doing so would be harmful or ineffective based on the state of the application.

WebPartVerb Класс не предоставляет уникальных методов; его предоставляемые методы являются переопределениями базовых методов.The WebPartVerb class does not expose any unique methods; its exposed methods are all overrides of base methods. Однако он содержит ряд свойств, о которых следует знать разработчикам.It does however contain a number of properties for developers to be aware of. Checked Свойство указывает, выбрана ли команда в данный момент.The Checked property indicates whether a verb is currently selected. Свойства ClientClickHandler иServerClickHandler ссылаются на соответствующие обработчики внутри класса (если они существуют) для событий щелчка клиента и сервера.The ClientClickHandler and ServerClickHandler properties refer to the respective handlers within the class (if any exist) for client and server click events. Description Свойство содержит текст, описывающий назначение команды в подсказке, когда пользователь наводит указатель мыши на команду в пользовательском интерфейсе.The Description property contains text that describes the purpose of a verb in a ToolTip when users position a mouse pointer over the verb in the UI. Enabled Свойство указывает текущее состояние команды, которая определяет, может ли пользователь щелкнуть команду и выполнить ее действие.The Enabled property indicates the current status of a verb, which determines whether a user can click the verb and execute its action. ID Свойство предоставляет уникальный идентификатор для объекта verb.The ID property provides a unique ID for the verb object. ImageUrl Свойство содержит URL-адрес изображения, которое можно использовать для представления глагола в пользовательском интерфейсе вместо отрисовки по умолчанию (обычно это кнопка или гиперссылка).The ImageUrl property contains a URL to an image that can be used to represent a verb in the UI in place of the default rendering (typically a button or a hyperlink). Text Свойство содержит текст метки, который отображается непосредственно в команде в пользовательском интерфейсе.The Text property contains the label text that appears directly on the verb in the UI. Переопределенное Visible свойство определяет, отображается ли команда в данный момент в пользовательском интерфейсе.The overridden Visible property determines whether a verb is currently displayed in the UI. Глаголы часто скрываются или отключаются в различном времени в веб-части приложении; Например, Специальные глаголы (например, команда редактирования и команда подключения) отображаются только в том случае, если на странице существуют соответствующие элементы управления, параметры и режимы отображения, чтобы разрешить этим командам принимать значимые действия.Verbs are often hidden or disabled at different times in a Web Parts application; for example, specialty verbs (such as the edit verb and the connect verb) are displayed only when the appropriate controls, settings, and display modes exist on the page to enable those verbs to take meaningful action.

Другие ключевые члены для работы с глаголами включают WebPartZoneBase.OnCreateVerbs метод, который является обработчиком событий, который может быть переопределен для пользовательской обработки процесса создания глагола WebPartZoneBase.CreateVerbs и события.Other key members for working with verbs include the WebPartZoneBase.OnCreateVerbs method, which is an event handler that can be overridden for custom handling of the verb creation process, and the WebPartZoneBase.CreateVerbs event.

Конструкторы

WebPartVerb(String, String)

Инициализирует новый экземпляр класса WebPartVerb и сопоставляет обработчик событий щелчка мыши на стороне клиента с этим экземпляром.Initializes a new instance of the WebPartVerb class and associates a client-side click event handler with the instance.

WebPartVerb(String, WebPartEventHandler)

Инициализирует новый экземпляр класса WebPartVerb и сопоставляет с этим экземпляром обработчик событий щелчка мыши на стороне сервера.Initializes a new instance of the WebPartVerb class and associates a server-side click event handler with the instance.

WebPartVerb(String, WebPartEventHandler, String)

Инициализирует новый экземпляр класса WebPartVerb и сопоставляет с этим экземпляром обработчики событий щелчка мыши как на стороне клиента, так и на стороне сервера.Initializes a new instance of the WebPartVerb class and associates both client and server-side click event handlers with the instance.

Свойства

Checked

Получает или задает значение, указывающее, что какое-либо состояние, сопоставленное с текущей командой, в настоящий момент активно или выбрано.Gets or sets a value indicating that some state associated with a custom verb is currently active or selected.

ClientClickHandler

Получает строку, содержащую имя метода обработчика событий на стороне клиента, определенного в конструкторе WebPartVerb.Gets the string containing the method name of the client-side event handler defined in the WebPartVerb constructor.

Description

Получает или задает краткое описание команды.Gets or sets a short description of the verb.

Enabled

Получает или задает значение, указывающее, активирована ли команда.Gets or sets a value that indicates whether a verb is enabled.

ID

Получает строку, содержащую уникальный идентификатор команды.Gets a string containing a unique ID for a verb.

ImageUrl

Получает или задает строку, содержащую URL-адрес изображения, которое представляет команду в пользовательском интерфейсе.Gets or sets a string containing a URL to an image that represents a verb in the user interface (UI).

IsTrackingViewState

Получает значение, которое указывает, отслеживается ли в настоящее время состояние представления команды.Gets a value that indicates whether view state is currently being tracked for a verb.

ServerClickHandler

Получает ссылку на метод, который обрабатывает события щелчка мыши на стороне сервера для команды.Gets a reference to the method that handles server-side click events for the verb.

Text

Получает или задает текстовые метки для команды, которая отображается в пользовательском интерфейсе.Gets or sets the text label for a verb that is displayed in the user interface (UI).

ViewState

Возвращает словарь сведений о состоянии, позволяющих сохранять и восстанавливать состояние представления серверного элемента управления при нескольких запросах одной и той же страницы.Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.

Visible

Получает или задает значение, которое указывает, видна ли команда пользователям.Gets or sets a value that indicates whether a verb is visible to users.

Методы

Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
LoadViewState(Object)

Восстанавливает сведения о состоянии представления из предыдущего запроса страницы, сохраненного методом SaveViewState().Restores view-state information from a previous page request that was saved by the SaveViewState() method.

MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
SaveViewState()

Сохраняет изменения состояния представления объекта WebPartVerb, которые произошли с момента последнего обратного запроса на сервер.Saves a WebPartVerb object's view-state changes that occurred since the page was last posted back to the server.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)
TrackViewState()

Отслеживает изменения состояния представления, чтобы сохранять изменения в объекте команды StateBag.Tracks view-state changes to a verb so the changes can be stored in the verb's StateBag object.

Явные реализации интерфейса

IStateManager.IsTrackingViewState

Реализует свойство IsTrackingViewState посредством вызова свойства WebPartVerb, принадлежащего классу IsTrackingViewState.Implements the IsTrackingViewState property by calling the WebPartVerb class's own IsTrackingViewState property.

IStateManager.LoadViewState(Object)

Реализует метод LoadViewState(Object) интерфейса IStateManager посредством вызова собственного метода WebPartVerb класса LoadViewState(Object).Implements the LoadViewState(Object) method of the IStateManager interface by calling the WebPartVerb class's own LoadViewState(Object) method.

IStateManager.SaveViewState()

Реализует метод SaveViewState() посредством вызова метода WebPartVerb, принадлежащего классу SaveViewState().Implements the SaveViewState() method by calling the WebPartVerb class's own SaveViewState() method.

IStateManager.TrackViewState()

Реализует метод TrackViewState() посредством вызова метода WebPartVerb, принадлежащего классу TrackViewState().Implements the TrackViewState() method by calling the WebPartVerb class's own TrackViewState() method.

Применяется к

Дополнительно