WebPartChrome.GetWebPartVerbs メソッド

.NET Framework クラス ライブラリ リファレンス

WebPartChrome.GetWebPartVerbs メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

WebPart コントロールで表示する必要がある動詞のコレクションを取得します。

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Protected Overridable Function
 GetWebPartVerbs ( _
    webPart As WebPart _
) As WebPartVerbCollection

Visual Basic (使用法)

Dim webPart As WebPart
Dim returnValue As WebPartVerbCollection

returnValue = Me.GetWebPartVerbs(webPart)

C#

protected virtual WebPartVerbCollection GetWebPartVerbs (
    WebPart webPart
)

C++

protected:
virtual WebPartVerbCollection^ GetWebPartVerbs (
    WebPart^ webPart
)

J#

protected WebPartVerbCollection GetWebPartVerbs (
    WebPart webPart
)

JScript

protected function GetWebPartVerbs (
    webPart : WebPart
) : WebPartVerbCollection

パラメータ

webPart

現在表示されているコントロール。

戻り値
webPart で表示する必要があるすべての動詞を格納している WebPartVerbCollection。

解説

GetWebPartVerbs メソッドには、開発者がメソッドをオーバーライドして特定の動詞が表示されないようにするための手段が用意されています。これは、やはり動詞が表示されないようにすることができる FilterWebPartVerbs メソッドに似ています。

ただし、GetWebPartVerbs メソッドは、複数の条件をチェックして動詞を表示するかどうかを判断する場合には使用できません。代わりに、このメソッドは、常に表示しない動詞が事前にわかっている場合には便利です。たとえば、カスタム WebPartChrome クラスを開発して、ユーザーがそのコントロールを閉じられないように、WebPart コントロールの Close 動詞を常に表示しないようにする場合があります。すべてのコントロールで AllowClose プロパティを false に設定するのではなく、単に GetWebPartVerbs メソッドをオーバーライドして、カスタム WebPartChrome オブジェクトで表示されるいずれの WebPart コントロール上にも Close 動詞が表示されないようにできます。

使用例

GetWebPartVerbs メソッドを使用するコード例を次に示します。例の実行に必要なコード全体については、WebPartChrome クラスの概要のトピックで「例」を参照してください。

GetWebPartVerbs メソッドをオーバーライドする方法を次のコード例に示します。オーバーライドされたメソッドは、基本メソッドを使用して webPart コントロールからすべての動詞を取得し、次にその動詞のコレクションを反復処理して Close 動詞を除くすべての動詞を ArrayList オブジェクトに追加します。この動詞の縮小セットが、次に呼び出し元に返される新しい WebPartVerbCollection に代入されます。

Visual Basic

Protected Overrides Function
 GetWebPartVerbs _
  (ByVal webPart As WebPart) As
 WebPartVerbCollection

  Dim verbSet As New ArrayList()
  Dim verb As WebPartVerb
  For Each verb In MyBase.GetWebPartVerbs(webPart)
    If verb.Text <> "Close"
 Then
      verbSet.Add(verb)
    End If
  Next verb

  Dim reducedVerbSet As WebPartVerbCollection
 = _
    New WebPartVerbCollection(verbSet)

  Return reducedVerbSet
End Function

C#

protected override WebPartVerbCollection GetWebPartVerbs(WebPart
 webPart)
{
  ArrayList verbSet = new ArrayList();
  foreach (WebPartVerb verb in base.GetWebPartVerbs(webPart))
  {
    if (verb.Text != "Close")
      verbSet.Add(verb);
  }
  WebPartVerbCollection reducedVerbSet = 
    new WebPartVerbCollection(verbSet);
  return reducedVerbSet;
}

ブラウザで Web ページを読み込んで、タイトル バーの下向きの矢印で示される各 WebPart コントロールの動詞メニューをクリックすると、Close 動詞がいずれのコントロールにも表示されないことを確認できます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebPartChrome クラス
WebPartChrome メンバ
System.Web.UI.WebControls.WebParts 名前空間
その他の技術情報
ASP.NET Web パーツ ページ