WebPartVerb WebPartVerb WebPartVerb WebPartVerb Class

定義

ユーザーが Web パーツ ページ上で操作を実行できる対話形式のユーザー インターフェイス (UI: User Interface) 要素を提供します。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
継承
WebPartVerbWebPartVerbWebPartVerbWebPartVerb
属性
実装

次のコード例は、カスタム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. コード例には、次の4つの部分があります。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のコントロールにWebPart追加OnCreateVerbsするためのメソッドをオーバーライドする単純なカスタムゾーンです。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コントロールを含む Web ページ。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. これを明示的にコンパイルし、生成されたアセンブリを Web サイトの 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. のコンパイル方法を示すチュートリアルについては、「チュートリアル:カスタム Web サーバーコントロールの開発と使用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

この例の2番目の部分には、カスタムゾーンとカスタム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

コード例の3番目の部分は、コントロールをホストする Web ページです。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. Web パーツのコピー動詞が表示されます。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 パーツ動詞は、Web パーツコントロールを使用するページに表示される、通常はボタンやハイパーリンクによって表される対話型 UI 要素です。Web Parts verbs are interactive UI elements, typically represented by buttons or hyperlinks, that appear in pages that use Web Parts controls. [動詞] をクリックすると、コントロールを閉じるWebPart 、または編集表示モード ( EditorZoneコントロールに関連付けられている特殊なページビュー) を閉じるなどの Web パーツコントロールに対して共通の UI 操作を実行できます。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). Web パーツコントロールセットによって提供されるすべての標準動詞は、Web パーツゾーンWebPartZone( EditorZone CatalogZone、、、 ConnectionsZoneまたは) またPartは Web パーツ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. ゾーンの UI を非表示にし、通常ブラウズモードのビューにページを返します。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 動詞OK verb EditorZoneBaseクラスを継承するゾーンで使用されます。Used with zones that inherit from the EditorZoneBase class. は、適用と終了の動詞の組み合わせ効果を持ちます。変更が適用され、ゾーンの UI が非表示になります。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. 2つのコントロール間の既存の接続を終了します。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 動詞を除く UI 内のすべてを非表示にします。Reduces the control to a minimal representation, hiding everything in its UI except the restore verb.
Restore 動詞Restore 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 動詞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. 接続 UI を開き、ユーザーがコントロール間の接続を作成できるようにします。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. 編集するコントロールを選択し、編集 UI を開きます。Selects the control for editing and opens the editing UI.
Export 動詞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.

Web パーツコントロールセットに用意されている標準動詞と共に、カスタム動詞を作成することもできます。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は、クラスから継承して1つ以上のカスタム動詞を作成することです。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.

Web パーツアプリケーションでは、 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.

動詞を作成するときに、ユーザーが動詞をクリックしたときに実行される、関連付けられたイベントハンドラーを2種類作成できます。これは、サーバー側のイベントハンドラー (サーバーで実行されるコード) と、クライアント側のイベントハンドラー (クライアントブラウザーで実行されるコード) です。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. たとえば、動詞が選択されたことを示す状態を作成し、その動詞が既に選択されていることをユーザーに通知するために、UI に適切な変更を加えることができます。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. もう1つの便利な動作は、動詞を無効にする機能です。これにより、ユーザーがアプリケーションの状態に応じて有害な場合や無効になった場合に、動詞をクリックするのを防ぐことができます。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. プロパティClientClickHandlerServerClickHandlerプロパティは、クラス内の各ハンドラー (存在する場合) をクライアントとサーバーのクリックイベントに参照します。The ClientClickHandler and ServerClickHandler properties refer to the respective handlers within the class (if any exist) for client and server click events. プロパティDescriptionには、ユーザーが UI の動詞の上にマウスポインターを置いたときに、ツールヒント内の動詞の目的を説明するテキストが含まれます。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 オブジェクトの一意の ID を提供します。The ID property provides a unique ID for the verb object. プロパティImageUrlには、既定の表示の代わりに UI 内の動詞を表すために使用できるイメージの 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は、UI の動詞に直接表示されるラベルテキストを格納します。The Text property contains the label text that appears directly on the verb in the UI. オーバーライドVisibleされたプロパティは、動詞が現在 UI に表示されているかどうかを判断します。The overridden Visible property determines whether a verb is currently displayed in the UI. 動詞は、多くの場合、Web パーツアプリケーションで異なるタイミングで表示または無効にされます。たとえば、特殊な動詞 (edit 動詞や connect 動詞など) は、適切な操作を実行できるように、適切なコントロール、設定、および表示モードがページに存在する場合にのみ表示されます。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(String, String) WebPartVerb(String, String) 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(String, WebPartEventHandler) WebPartVerb(String, WebPartEventHandler) 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(String, WebPartEventHandler, String) WebPartVerb(String, WebPartEventHandler, String) 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 Checked Checked Checked

カスタム動詞に関連付けられた何らかの状態が、現在アクティブな状態または選択された状態にあることを示す値を取得または設定します。Gets or sets a value indicating that some state associated with a custom verb is currently active or selected.

ClientClickHandler ClientClickHandler ClientClickHandler ClientClickHandler

WebPartVerb コンストラクターに定義されたクライアント側イベント ハンドラーのメソッド名を含む文字列を取得します。Gets the string containing the method name of the client-side event handler defined in the WebPartVerb constructor.

Description Description Description Description

動詞の簡単な説明を取得または設定します。Gets or sets a short description of the verb.

Enabled Enabled Enabled Enabled

動詞が有効かどうかを示す値を取得または設定します。Gets or sets a value that indicates whether a verb is enabled.

ID ID ID ID

動詞の一意の ID を含む文字列を取得します。Gets a string containing a unique ID for a verb.

ImageUrl ImageUrl ImageUrl ImageUrl

ユーザー インターフェイス (UI) 内の動詞を表すイメージの URL を含んだ文字列を取得または設定します。Gets or sets a string containing a URL to an image that represents a verb in the user interface (UI).

IsTrackingViewState IsTrackingViewState IsTrackingViewState IsTrackingViewState

動詞のビューステートが現在追跡されているかどうかを示す値を取得します。Gets a value that indicates whether view state is currently being tracked for a verb.

ServerClickHandler ServerClickHandler ServerClickHandler ServerClickHandler

動詞に対するサーバー側のクリック イベントを処理するメソッドへの参照を取得します。Gets a reference to the method that handles server-side click events for the verb.

Text Text Text Text

ユーザー インターフェイス (UI) に表示される動詞のテキスト ラベルを取得または設定します。Gets or sets the text label for a verb that is displayed in the user interface (UI).

ViewState ViewState ViewState 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 Visible Visible Visible

ユーザーに対して動詞が表示されるかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether a verb is visible to users.

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
LoadViewState(Object) LoadViewState(Object) LoadViewState(Object) LoadViewState(Object)

SaveViewState() メソッドによって保存された前回のページ要求からビューステート情報を復元します。Restores view-state information from a previous page request that was saved by the SaveViewState() method.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
SaveViewState() SaveViewState() SaveViewState() SaveViewState()

前回ページがサーバーにポストバックされた後で発生した WebPartVerb オブジェクトのビューステートの変更を保存します。Saves a WebPartVerb object's view-state changes that occurred since the page was last posted back to the server.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)
TrackViewState() TrackViewState() TrackViewState() TrackViewState()

動詞のビューステートの変更を追跡し、変更を動詞の StateBag オブジェクトに格納できるようにします。Tracks view-state changes to a verb so the changes can be stored in the verb's StateBag object.

明示的なインターフェイスの実装

IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState

IsTrackingViewState クラス独自の WebPartVerb プロパティを呼び出すことにより、IsTrackingViewState プロパティを実装します。Implements the IsTrackingViewState property by calling the WebPartVerb class's own IsTrackingViewState property.

IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) 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() IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState()

SaveViewState() クラス独自の WebPartVerb メソッドを呼び出すことにより、SaveViewState() メソッドを実装します。Implements the SaveViewState() method by calling the WebPartVerb class's own SaveViewState() method.

IStateManager.TrackViewState() IStateManager.TrackViewState() IStateManager.TrackViewState() IStateManager.TrackViewState()

TrackViewState() クラス独自の WebPartVerb メソッドを呼び出すことにより、TrackViewState() メソッドを実装します。Implements the TrackViewState() method by calling the WebPartVerb class's own TrackViewState() method.

適用対象

こちらもご覧ください