WebPartChrome.GetWebPartVerbs(WebPart) メソッド

定義

名前空間:

System.Web.UI.WebControls.WebParts

アセンブリ:

System.Web.dll

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

protected:
 virtual System::Web::UI::WebControls::WebParts::WebPartVerbCollection ^ GetWebPartVerbs(System::Web::UI::WebControls::WebParts::WebPart ^ webPart);

protected virtual System.Web.UI.WebControls.WebParts.WebPartVerbCollection GetWebPartVerbs (System.Web.UI.WebControls.WebParts.WebPart webPart);

abstract member GetWebPartVerbs : System.Web.UI.WebControls.WebParts.WebPart -> System.Web.UI.WebControls.WebParts.WebPartVerbCollection
override this.GetWebPartVerbs : System.Web.UI.WebControls.WebParts.WebPart -> System.Web.UI.WebControls.WebParts.WebPartVerbCollection

Protected Overridable Function GetWebPartVerbs (webPart As WebPart) As WebPartVerbCollection

パラメーター

webPart

WebPart

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

戻り値

WebPartVerbCollection

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

例外

ArgumentNullException

webPart が nullです。

例

次のコード例では、 メソッドの使用方法を GetWebPartVerbs 示します。 この例を実行するために必要な完全なコードについては、クラスの概要に関するトピックの「例」セクションを WebPartChrome 参照してください。

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

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;
}

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

ブラウザーで Web ページを読み込み、各 WebPart コントロールの動詞メニュー (タイトル バーに下向き矢印付きで表示) をクリックすると、閉じる動詞がコントロールに対してレンダリングされないことがわかります。

注釈

メソッドを使用すると、開発者は GetWebPartVerbs メソッドをオーバーライドし、特定の動詞をレンダリングから除外できます。 これは、 メソッドに似ています。 FilterWebPartVerbs また、動詞をレンダリングから除外することもできます。

ただし、 メソッドは、 GetWebPartVerbs 動詞をレンダリングするかどうかを決定するためにいくつかの条件を確認する場合を対象としていません。 代わりに、このメソッドは、特定の動詞を常に除外する必要があることがわかっている場合に便利です。 たとえば、カスタム WebPartChrome クラスを開発する場合は、ユーザーがコントロールを閉じないように、常にコントロールの WebPart 閉じる動詞を除外することを決定できます。 すべてのコントロールで プロパティを AllowClose にfalse設定するのではなく、 メソッドをオーバーライドGetWebPartVerbsし、カスタム WebPartChrome オブジェクトでレンダリングされたコントロールWebPartで閉じる動詞がレンダリングされないようにすることができます。

こちらもご覧ください

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