Language

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

WebPartVerbCollectionでレンダリングされるすべての動詞を含むwebPart。

例外

ArgumentNullException

webPart は nullです。

例

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

コード例の次のセクションでは、 GetWebPartVerbs メソッドをオーバーライドする方法を示します。 オーバーライドされたメソッドは、基本メソッドを使用して、 webPart コントロールからすべての動詞を取得し、動詞コレクションを反復処理し、閉じた動詞を除くすべての動詞を 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 メソッドをオーバーライドするだけで、カスタム WebPart オブジェクトでレンダリングされたWebPartChrome コントロールに近い動詞がレンダリングされないようにすることができます。

適用対象

こちらもご覧ください