WebPartZoneBase.CloseVerb プロパティとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

WebPartZoneBase.CloseVerb プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

エンドユーザーがゾーン内の WebPart コントロールを終了できるようにする WebPartVerb オブジェクトへの参照を取得します。

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

Visual Basic (宣言)

Public Overridable ReadOnly
 Property CloseVerb As WebPartVerb

Visual Basic (使用法)

Dim instance As WebPartZoneBase
Dim value As WebPartVerb

value = instance.CloseVerb

public virtual WebPartVerb CloseVerb { get;
 }

C++

public:
virtual property WebPartVerb^ CloseVerb {
    WebPartVerb^ get ();
}

/** @property */
public WebPartVerb get_CloseVerb ()

JScript

public function get CloseVerb
 () : WebPartVerb

プロパティ値
エンドユーザーが WebPart コントロールを終了できるようにする WebPartVerb。

解説

CloseVerb プロパティによって参照される close 動詞は、ゾーン内の各 WebPart コントロールの動詞メニューに表示されます。

コントロールは、終了されるとページでの対話から削除されます。ただし、開発者が PageCatalogPart コントロールを含む CatalogZone ゾーンなどの適切なユーザーインターフェイス (UI) を用意している場合、ユーザーはページを CatalogDisplayMode に切り替えて、前に終了したコントロールのインスタンスをページに戻すことができます。

使用例

WebPartZone コントロールで CloseVerb プロパティを使用するコード例を次に示します。コード例が正常に処理されるためには、HelpVerb プロパティの例のすべてのコードが必要です。

コード例の次の部分は、部分クラスのコードで、help 動詞が有効か無効かを切り替えるコードを含んでいます。

Visual Basic

Protected Sub CheckBoxList1_SelectedItemIndexChanged(ByVal
 sender As [Object], ByVal e As
 EventArgs)
  Dim item As ListItem
  For Each item In CheckBoxList1.Items
    Dim theVerb As WebPartVerb
    Select Case item.Value
      Case "close"
        theVerb = WebPartZone1.CloseVerb
      Case "export"
        theVerb = WebPartZone1.ExportVerb
      Case "delete"
        theVerb = WebPartZone1.DeleteVerb
      Case "minimize"
        theVerb = WebPartZone1.MinimizeVerb
      Case "restore"
        theVerb = WebPartZone1.RestoreVerb
      Case Else
        theVerb = Nothing
    End Select

    If item.Selected Then
      theVerb.Enabled = True
    Else
      theVerb.Enabled = False
    End If
  Next item

End Sub

protected void CheckBoxList1_SelectedItemIndexChanged(Object
 sender, EventArgs e)
{
  foreach (ListItem item in CheckBoxList1.Items)
  {
    WebPartVerb theVerb;
    switch (item.Value)
    {
      case "close":
        theVerb = WebPartZone1.CloseVerb;
        break;
      case "export":
        theVerb = WebPartZone1.ExportVerb;
        break;
      case "delete":
        theVerb = WebPartZone1.DeleteVerb;
        break;
      case "minimize":
        theVerb = WebPartZone1.MinimizeVerb;
        break;
      case "restore":
        theVerb = WebPartZone1.RestoreVerb;
        break;
      default:
        theVerb = null;
        break;
    }

    if (item.Selected)
      theVerb.Enabled = true;
    else
      theVerb.Enabled = false;
  }
}

コード例のその他の部分は、カスタムコントロールをホストし、UI を含む Web ページです。ゾーン内の宣言 <CloseVerb> 要素で WebPart コントロールの動詞メニューの close 動詞を表す特定のテキストが設定されています。

Visual Basic

<asp:WebPartZone ID="WebPartZone1" Runat="server">
  <CloseVerb Text="Close WebPart" />
  <HelpVerb Text="View Help" />
  <ExportVerb Text="Export WebPart Definition"
 />
  <DeleteVerb Text ="Delete WebPart" />
  <MinimizeVerb Description="Minimize the control"
 />
  <RestoreVerb Description="Restore the control"
 />
  <ZoneTemplate>
  </ZoneTemplate>  
</asp:WebPartZone>

<asp:WebPartZone ID="WebPartZone1" Runat="server">
  <CloseVerb Text="Close WebPart" />
  <HelpVerb Text="View Help" />
  <ExportVerb Text="Export WebPart Definition" />
  <DeleteVerb Text ="Delete WebPart" />
  <MinimizeVerb Description="Minimize the control" />
  <RestoreVerb Description="Restore the control" />
  <ZoneTemplate>
  </ZoneTemplate>  
</asp:WebPartZone>

また、コード例では、基になるカスタム WebPart コントロールとして、TextDisplayWebPart という名前のコントロールが使用され、そのコンストラクタで AllowClose プロパティを false に設定しています。このため、次のコード例でコントロールを終了できるようにするために、カタログ内の <aspSample:TextDisplayPart> 要素で AllowClose プロパティを true に設定する必要があります。

Visual Basic

<asp:CatalogZone ID="CatalogZone1" Runat="server">
  <ZoneTemplate>
    <asp:DeclarativeCatalogPart ID="DeclarativeCatalogPart1"
 
      Runat="server">
      <WebPartsTemplate>
        <aspSample:TextDisplayWebPart 
          runat="server"   
          id="textwebpart" 
          title = "Text Content WebPart" 
          width="350px" 
          AllowClose="true"
          ExportMode="All"
          HelpMode="Modal"
          HelpUrl="TextWebPartHelp.htm" />    
        
      </WebPartsTemplate>
    </asp:DeclarativeCatalogPart> 
    <asp:PageCatalogPart ID="PageCatalogPart1"
 Runat="server" />
  </ZoneTemplate>
</asp:CatalogZone>

<asp:CatalogZone ID="CatalogZone1" Runat="server">
  <ZoneTemplate>
    <asp:DeclarativeCatalogPart ID="DeclarativeCatalogPart1" 
      Runat="server">
      <WebPartsTemplate>
        <aspSample:TextDisplayWebPart 
          runat="server"   
          id="textwebpart" 
          title = "Text Content WebPart" 
          width="350px" 
          AllowClose="true"
          ExportMode="All"
          HelpMode="Modal"
          HelpUrl="TextWebPartHelp.htm" />            
      </WebPartsTemplate>
    </asp:DeclarativeCatalogPart> 
    <asp:PageCatalogPart ID="PageCatalogPart1" Runat="server"
 />
  </ZoneTemplate>
</asp:CatalogZone>