WebPart.Hidden プロパティ

  • リファレンス

定義

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

WebPart コントロールが Web ページに表示されるかどうかを示す値を取得または設定します。

public:
 virtual property bool Hidden { bool get(); void set(bool value); };
[System.Web.UI.Themeable(false)]
[System.Web.UI.WebControls.WebParts.Personalizable]
public virtual bool Hidden { get; set; }
[<System.Web.UI.Themeable(false)>]
[<System.Web.UI.WebControls.WebParts.Personalizable>]
member this.Hidden : bool with get, set
Public Overridable Property Hidden As Boolean

プロパティ値

Boolean

Web ページに WebPart コントロールが表示される場合は false。それ以外の場合は true。 既定値は false です。

属性
ThemeableAttribute PersonalizableAttribute

例

次のコード例では、カスタム Web パーツ コントロールの Hidden プロパティの使用方法を示します。 この例では、 TextDisplayWebPartクラスの概要の「例」セクション WebPart にあるカスタム コントロール を使用することを前提としています。

Web ページの 要素の宣言型マークアップ <aspSample:TextDisplayWebPart> では、 Hidden 属性値が に設定されていることに注意してください true。 TextDisplayWebPartページがブラウザーに読み込まれている場合、コントロールは表示されません。 ただし、コントロールは引き続きページとそのゾーンに存在し、それらの接続を作成した場合でも他 WebPart のコントロールとの接続に参加できます。

<%@ 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" 
            Hidden="true" />
          </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" 
            Hidden="true" />
          </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

注釈

WebPart非表示のコントロールは、そのゾーンに残り、実際にはページにレンダリングされ、ブラウザーに表示されない場合でも、フェーズなどのPreRenderページ ライフ サイクル フェーズに参加します。 閉じたコントロールはページにレンダリングされず、非表示のコントロールは Web パーツ アプリケーションでレンダリングされアクティブになりますが、ユーザーには表示されないため、これは閉じているコントロールとは異なります WebPart 。 Web パーツ コントロール セットは、 WebPart カスケード スタイル シート (CSS) スタイルを の display:none値に設定することで、コントロールを非表示にします。

コントロールの プロパティが Hidden に true設定されている場合でも、ページ上の現在の表示モードで非表示のコントロールを表示できる場合、コントロールは引き続き表示されます。 たとえば、ユーザーが編集できるように、編集モードでは非表示のコントロールを表示できます。 非表示のコントロールが特定の表示モードで表示されている場合、コントロールのタイトルには、コントロールが非表示の状態であることを示す文字列が表示されます。

コントロールの HiddenWebPart プロパティが に false設定されている場合(既定値)、コントロールはページに表示されます。 プロパティが AllowHide に false設定されている場合、エンド ユーザーはプロパティ値を Hidden 編集できません。

このプロパティは、テーマまたはスタイル シート テーマによって設定することはできません。 詳細については、「テーマとスキンの ASP.NET」を参照してくださいThemeableAttribute。

適用対象

こちらもご覧ください