WebPart.AllowClose 屬性

參考

定義

命名空間:: System.Web.UI.WebControls.WebParts

組件:: System.Web.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

取得或設定值，指出使用者可以在 Web 網頁上關閉 WebPart 控制項。

public:
 virtual property bool AllowClose { bool get(); void set(bool value); };

[System.Web.UI.Themeable(false)]
[System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)]
public virtual bool AllowClose { get; set; }

[<System.Web.UI.Themeable(false)>]
[<System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)>]
member this.AllowClose : bool with get, set

Public Overridable Property AllowClose As Boolean

屬性值

Boolean

如果控制項可以在 Web 網頁上關閉，則為 true，否則為 false。預設值是 true。

屬性: ThemeableAttribute PersonalizableAttribute

範例

下列程式碼範例示範如何變更自訂 WebPart 控制項之 AllowClose 屬性的預設設定，使其無法關閉。

此範例的第一個部分包含名為 TextDisplayWebPart 的自訂 WebPart 控制項程式碼。請注意，在自訂控制項的建構函式中 TextDisplayWebPart.AllowClose ，屬性會設定為 false ，這會影響防止使用者在網頁上關閉控制項。這表示使用者將會停用控制項之動詞功能表的關閉動詞。若要執行程式碼範例，您必須編譯此原始程式碼。您可以明確地編譯它，並將產生的元件放在網站的 Bin 資料夾或全域組件快取中。或者，您可以將原始程式碼放在月臺的App_Code資料夾中，在執行時間將動態編譯。此程式碼範例假設您將原始程式碼編譯成元件、將它放在 Web 應用程式的 Bin 子資料夾中，並在網頁中使用指示詞參考元件 Register 。如需示範這兩種編譯方法的逐步解說，請參閱逐步解說：開發和使用自訂 Web 服務器控制項。

using System;
using System.Security.Permissions;
using System.Web;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

namespace Samples.AspNet.CS.Controls
{
  [AspNetHostingPermission(SecurityAction.Demand, 
    Level=AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand, 
    Level=AspNetHostingPermissionLevel.Minimal)]
  public class TextDisplayWebPart : WebPart
  {
    private String _contentText = null;
    TextBox input;
    Label DisplayContent;

    public TextDisplayWebPart()
    {
      this.AllowClose = false;
    }

    [Personalizable(), WebBrowsable]
    public String ContentText
    {
      get { return _contentText; }
      set { _contentText = value; }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      DisplayContent.BackColor = 
        System.Drawing.Color.LightBlue;
      DisplayContent.Text = this.ContentText;
      this.Controls.Add(DisplayContent);
      input = new TextBox();
      this.Controls.Add(input);
      Button update = new Button();
      update.Text = "Set Label Content";
      update.Click += new EventHandler(this.submit_Click);
      this.Controls.Add(update);
      ChildControlsCreated = true;
    }

    private void submit_Click(object sender, EventArgs e)
    {
      // Update the label string.
      if (!string.IsNullOrEmpty(input.Text))
      {
        _contentText = input.Text + @"<br />";
        input.Text = String.Empty;
        DisplayContent.Text = this.ContentText;
      }
    }
  }
}

Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts

Namespace Samples.AspNet.VB.Controls

<AspNetHostingPermission(SecurityAction.Demand, _
  Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
  Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class TextDisplayWebPart
    Inherits WebPart
    Private _contentText As String = Nothing
    Private input As TextBox
    Private DisplayContent As Label
    
    
    Public Sub New() 
      Me.AllowClose = False
    End Sub
    
    <Personalizable(), WebBrowsable()>  _
    Public Property ContentText() As String 
        Get
            Return _contentText
        End Get
        Set
            _contentText = value
        End Set
    End Property
     
    Protected Overrides Sub CreateChildControls() 
        Controls.Clear()
        DisplayContent = New Label()
        DisplayContent.Text = Me.ContentText
        DisplayContent.BackColor = _
          System.Drawing.Color.LightBlue
        Me.Controls.Add(DisplayContent)
        input = New TextBox()
        Me.Controls.Add(input)
        Dim update As New Button()
        update.Text = "Set Label Content"
        AddHandler update.Click, AddressOf Me.submit_Click
        Me.Controls.Add(update)
        ChildControlsCreated = True
    
    End Sub
    
    
    Private Sub submit_Click(ByVal sender As Object, _
                             ByVal e As EventArgs) 
        ' Update the label string.
        If input.Text <> String.Empty Then
            _contentText = input.Text & "<br />"
            input.Text = String.Empty
            DisplayContent.Text = Me.ContentText
        End If
    
    End Sub
    
End Class

End Namespace

範例的第二個部分示範如何參考 TextDisplayWebPart ASP.NET 網頁中的控制項。請注意，在參考控制項的元素中 <aspSample:TextDisplayWebPart> ，您也可以變更控制項建構函式所設定的屬性值。若要允許關閉控制項，只要將屬性加入 AllowClose="true" 宣告式標記中的專案即可。

<%@ page language="C#" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.CS.Controls" 
             Assembly="TextDisplayWebPartCS"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      title="Zone 1"
      PartChromeType="TitleAndBorder">
        <parttitlestyle font-bold="true" ForeColor="#3300cc" />
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

<%@ page language="VB" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.VB.Controls" 
             Assembly="TextDisplayWebPartVB"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      title="Zone 1"
      PartChromeType="TitleAndBorder">
        <parttitlestyle font-bold="true" ForeColor="#3300cc" />
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

備註

當使用者關閉 WebPart 網頁上的控制項之後，該控制項就不會再顯示或可在頁面上使用。關閉的控制項會新增至頁面目錄，這是儲存控制項參考的Web 組件實體。如果開發人員將控制項新增 PageCatalogPart 至控制項內的 CatalogZone 頁面，使用者就可以將頁面切換至目錄顯示模式、選取頁面目錄中的關閉控制項，然後將它新增回頁面。

注意

關閉 WebPart 的控制項可以透過程式設計方式新增回頁面，或是在頁面目錄處於目錄顯示模式時，從頁面目錄選取關閉控制項的使用者。

WebPart關閉控制項與刪除控制項不同。關閉的控制項可以新增回頁面，同時永久移除已刪除的控制項。如需刪除控制項的詳細資訊，請參閱 DeleteWebPart 方法。關閉控制項也與隱藏控制項不同。隱藏的控制項仍存在於頁面上，仍然參與頁面生命週期事件，而且只會隱藏使用者檢視，但關閉的控制項甚至不會在頁面上呈現。

靜態和動態 WebPart 控制項 (靜態控制項都會在頁面的標記中宣告，而動態控制項則以程式設計方式新增) 可以關閉。

如果開發人員將屬性設定 AllowClose 為 false ，則控制項上不會出現關閉動詞，而且使用者無法關閉控制項。

這個屬性無法由佈景主題或樣式表主題設定。如需詳細資訊，請參閱 ThemeableAttribute 和ASP.NET 主題和麵板。

此屬性的個人化範圍會設定為 Shared ，而且只能由授權的使用者修改。如需詳細資訊，請參閱 PersonalizableAttribute 和Web 組件個人化概觀。

適用於

WebPart.AllowClose 屬性

定義

屬性值

範例

備註

適用於

另請參閱

其他資源