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 コントロールの動詞メニューに動詞を追加するカスタム ゾーンを作成する方法を示しています。 コード例には、次の 4 つの部分があります。

• テキストを表示する単純なカスタム WebPart コントロールを含むソース ファイル。

• カスタム WebPartVerb オブジェクトを含むソース ファイルと、カスタム動詞をゾーン内のコントロールに追加するメソッドをオーバーライドOnCreateVerbsするWebPart単純なWebPartZoneBaseカスタム ゾーン。

• カスタム ゾーンと WebPart カスタム コントロールを含む Web ページ。

• この例の動作の説明。

コード例の最初の部分には、テキストを表示する単純な WebPart コントロールを作成するソース コードが含まれています。 コード例を実行するには、このソース コードをコンパイルする必要があります。 明示的にコンパイルし、結果のアセンブリを Web サイトの Bin フォルダーまたはグローバル アセンブリ キャッシュに配置できます。 または、ソース コードをサイトの App_Code フォルダーに配置して、実行時に動的にコンパイルすることもできます。 このコード例では、動的コンパイル アプローチを使用します。 コンパイル方法を示すチュートリアルについては、「 チュートリアル: カスタム Web サーバー コントロールの開発と使用」を参照してください。

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 含まれています。 ゾーンでは、 メソッドが 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

コード例の 3 番目の部分は、コントロールをホストする Web ページです。 カスタム コントロールの名前空間を 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 コントロールの動詞メニューをクリックします。 Web パーツのコピー動詞を表示する必要があります。 動詞をクリックし、コントロールのコピーがゾーンに追加されることに注意してください。

注釈

Web パーツ動詞は、Web パーツ コントロールを使用するページに表示される、通常はボタンまたはハイパーリンクで表される対話型 UI 要素です。 ユーザーは動詞をクリックして、コントロールを閉じた WebPart り、編集表示モード (コントロールに関連付けられた特殊なページ ビュー) を閉じたりするなど、Web パーツ コントロールの一般的な UI アクションを EditorZone 実行します。 Web パーツ コントロール セットで提供されるすべての標準動詞は、Web パーツ ゾーン (WebPartZone、EditorZoneCatalogZoneまたは ) または ConnectionsZoneWeb パーツ Part コントロール (WebPart、、EditorPartGenericWebPart、または CatalogPart) のいずれかに関連付けられます。

標準動詞がゾーンに関連付けられている場合、そのアクションはゾーン レベルで適用され、動詞は通常、ゾーンのヘッダーまたはフッター領域に表示されます。 次の表に、一般的なゾーン レベルの動詞とそのアクションを示します。

コントロールに関連付けられている標準動詞に関 Part しては、そのアクションはコントロール自体 (またはその子コントロール) に適用されます。 パーツ コントロールは、動詞のコンテナーとして機能し、動詞のレンダリングを管理します。 パーツ コントロールに関連付けられているほとんどの標準動詞は、タイトル バーまたはタイトル バー内のドロップダウン動詞メニューに直接表示されます。 これらの動詞がヘッダーまたは動詞メニューに直接表示されるかどうかは、 プロパティによって WebPartVerbRenderMode 決まります。既定では、動詞は動詞メニューに表示されます。 次の表に、さまざまなコントロールに関連付けられている一般的な Part 動詞とそのアクションを示します。

Web パーツ コントロール セットで提供される標準動詞と共に、カスタム動詞を作成することもできます。 カスタム動詞を作成する一般的なシナリオは、コントロールに関連付 Part けられた動詞を作成することです。 これらの動詞を作成すると、既定では、標準の動詞と共に動詞メニューに表示されます。 このような動詞を作成するための基本的な方法は、 クラスから継承して、1 つ以上の WebPartVerb カスタム動詞を作成することです。 次に、基本クラスから継承するコントロールを WebPart 作成し、カスタム WebPartVerb オブジェクトをコレクションに WebPartVerbCollection 追加します。 このコレクションをコントロールのコレクションに Verbs 追加すると、実行時にコントロールの動詞メニューにカスタム動詞が自動的に表示されます。 標準動詞と同様に、コントロール上のカスタム動詞にプログラムで WebPart アクセスできます。

Web パーツ アプリケーションでは、カスタム コントロール、ユーザー コントロール、ASP.NET コントロールなど、クラスから WebPart 継承されないサーバー コントロールを使用できます。 これらのサーバー コントロールは、ゾーンに WebPartZoneBase 追加された場合、実行時にオブジェクトで GenericWebPart 動的にラップされ、実行時 WebPart コントロールとして機能できるようになります。 クラスからWebPart継承されないサーバー コントロールにカスタム動詞を追加するには、サーバー コントロールで インターフェイスを実装し、そのプロパティをIWebActionableVerbsオーバーライドする必要があります。

動詞を作成するときに、ユーザーが動詞をクリックしたときに実行される関連付けられたイベント ハンドラーの 2 種類を作成できます。サーバー側イベント ハンドラー (サーバー上で実行されるコード)、およびクライアント側イベント ハンドラー (クライアント ブラウザーで実行されるコード)。 また、動詞のカスタム状態を定義することもできます。これは、ユーザーに視覚的な手掛かりを提供するのに便利な方法です。 たとえば、動詞が選択されたことを示す状態を作成し、UI に適切な変更を提供して、動詞が既に選択されていることをユーザーに通知できます。 もう 1 つの便利な動作は、動詞を無効にする機能です。これを行うことで、アプリケーションの状態に基づいて有害または無効になる場合に、ユーザーが動詞をクリックするのを防ぐことができます。

クラスは WebPartVerb 一意のメソッドを公開しません。その公開されたメソッドはすべて基本メソッドのオーバーライドです。 ただし、開発者が注意すべきプロパティが多数含まれています。 プロパティは Checked 、動詞が現在選択されているかどうかを示します。 プロパティと プロパティは ClientClickHandler 、クライアントと ServerClickHandler サーバーのクリック イベントのクラス内のそれぞれのハンドラー (存在する場合) を参照します。 プロパティには Description 、ユーザーが UI 内の動詞の上にマウス ポインターを置いたときに、ツールヒント内の動詞の目的を説明するテキストが含まれています。 プロパティは Enabled 、ユーザーが動詞をクリックしてそのアクションを実行できるかどうかを決定する動詞の現在の状態を示します。 プロパティは ID 、動詞オブジェクトの一意の ID を提供します。 ImageUrlプロパティには、既定のレンダリング (通常はボタンまたはハイパーリンク) の代わりに UI で動詞を表すために使用できるイメージへの URL が含まれています。 プロパティには Text 、UI の動詞に直接表示されるラベル テキストが含まれています。 オーバーライドされた Visible プロパティは、動詞が UI に現在表示されているかどうかを決定します。 多くの場合、動詞は Web パーツ アプリケーションで異なる時点で非表示または無効になります。たとえば、特殊動詞 (編集動詞や接続動詞など) は、適切なコントロール、設定、および表示モードがページ上に存在する場合にのみ表示され、これらの動詞が意味のあるアクションを実行できるようにします。

動詞を操作するための他の主要なメンバーには、 メソッドが含まれます WebPartZoneBase.OnCreateVerbs 。これは、動詞作成プロセスのカスタム処理でオーバーライドできるイベント ハンドラーであり、イベントです WebPartZoneBase.CreateVerbs 。

コンストラクター

プロパティ

メソッド

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

適用対象

こちらもご覧ください

• Verbs
• Verbs
• WebPartVerbCollection
• ASP.NET Web パーツ コントロール