Share via

WebPartZoneBase.CloseVerb プロパティ

  • リファレンス

定義

名前空間:
System.Web.UI.WebControls.WebParts
アセンブリ:
System.Web.dll

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

public:
 virtual property System::Web::UI::WebControls::WebParts::WebPartVerb ^ CloseVerb { System::Web::UI::WebControls::WebParts::WebPartVerb ^ get(); };
[System.Web.UI.PersistenceMode(System.Web.UI.PersistenceMode.InnerProperty)]
public virtual System.Web.UI.WebControls.WebParts.WebPartVerb CloseVerb { get; }
[<System.Web.UI.PersistenceMode(System.Web.UI.PersistenceMode.InnerProperty)>]
member this.CloseVerb : System.Web.UI.WebControls.WebParts.WebPartVerb
Public Overridable ReadOnly Property CloseVerb As WebPartVerb

プロパティ値

WebPartVerb

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

属性
PersistenceModeAttribute

例

次のコード例では、コントロールで プロパティを CloseVerb 使用する方法を WebPartZone 示します。 コード例を機能させるには、 プロパティの [例] セクションのすべてのコードが HelpVerb 必要です。

コード例の次の部分は部分クラスのものであり、ヘルプ動詞が有効か無効かを切り替えるコードが含まれています。

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

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

コード例のもう 1 つの部分は、カスタム コントロールをホストし、UI を含む Web ページです。 ゾーン内の宣言型 <CloseVerb> 要素によって、コントロールの動詞メニューの閉じる動詞を表す特定のテキストが設定されていることに WebPart 注意してください。

<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-- がコンストラクターで プロパティを にfalse設定AllowCloseするため、次のコード例でコントロールを閉じることができるように、<aspSample:TextDisplayPart>カタログ内の 要素で プロパティを にtrue設定AllowCloseする必要があることにも注意してください。

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

ブラウザーでページを読み込んだ後、ページをカタログ表示モードに切り替えて、コントロールを TextDisplayWebPart ページに追加します。 チェック ボックスを使用して閉じる動詞を有効または無効にしたり、動詞メニューの [WebPart を閉じる] 動詞をクリックしてコントロールを閉じることもできます。 コントロールを閉じた後、ページをカタログ表示モードに戻した場合は、[ ページ カタログ] をクリックし、閉じたコントロールの元の TextDisplayWebPart インスタンスを選択して、ページ上で再度開くことができます。

注釈

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

コントロールを閉じると、ページでの操作から削除されますが、開発者がコントロールを含むPageCatalogPartゾーンなどのCatalogZone適切なユーザー インターフェイス (UI) を提供する場合、ユーザーはページを にCatalogDisplayMode切り替えて、コントロールの以前に閉じたインスタンスをページに追加できます。

適用対象

こちらもご覧ください