CatalogZoneBase.InstructionText プロパティ

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

CatalogZoneBase.InstructionText プロパティ

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

ゾーン内に表示される、エンド ユーザーに指示を与えるテキストを取得または設定します。

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

Visual Basic (宣言)

Public Overrides Property
 InstructionText As String

Visual Basic (使用法)

Dim instance As CatalogZoneBase
Dim value As String

value = instance.InstructionText

instance.InstructionText = value

C#

public override string InstructionText { get;
 set; }

C++

public:
virtual property String^ InstructionText {
    String^ get () override;
    void set (String^ value) override;
}

J#

/** @property */
public String get_InstructionText ()

/** @property */
public void set_InstructionText (String value)

JScript

public override function get
 InstructionText () : String

public override function set
 InstructionText (value : String)

プロパティ値
エンド ユーザーに対する指示を含む文字列。既定のカルチャ固有の文字列は、Web パーツ コントロール セットによって提供されます。

解説

InstructionText プロパティの文字列値は、CatalogZoneBase ゾーンのヘッダー領域のすぐ下に表示されます。InstructionText プロパティのテキストは、ページがカタログ表示モードになり、カタログ ユーザー インターフェイス (UI) が表示できるようになると表示されます。

InstructionText プロパティの目的は、カタログ UI が表示されたときの操作についての一般的な指示をユーザーに与えることです。

使用例

InstructionText プロパティの使用方法を次のコード例に示します。宣言を使用した方法とプログラムを使用した方法の 2 とおりの方法を紹介します。例の実行に必要なコード全体については、CatalogZoneBase クラスの概要で「例」を参照してください。

コード例では、2 つの <asp:catalogzone> 要素を宣言しており、1 つ目は InstructionText プロパティの値を宣言しています。

Visual Basic

<asp:CatalogZone ID="CatalogZone1" runat="server"
  EmptyZoneText="No controls are in the zone."
  HeaderText="My Web Parts Catalog"
  InstructionText="Add Web Parts controls to the zone."
  PartLinkStyle-Font-Italic="true"
  SelectedPartLinkStyle-Font-Bold="true"
  SelectTargetZoneText="Select zone"
  AddVerb-Text="Add Control"
  CloseVerb-Description="Close and return to browse mode."
 
  SelectedCatalogPartID="Currently Selected CatalogPart ID.">
  <ZoneTemplate>
    <asp:DeclarativeCatalogPart ID="DeclarativeCatalogPart1"
 
      runat="server">
      <WebPartsTemplate>
        <aspSample:TextDisplayWebPart 
          runat="server"   
          id="textwebpart" 
          title = "Text Content WebPart" 
          ExportMode="All"/>  
        <asp:Calendar id="calendar1" runat="server"
 
          title="My Calendar" />              
 
      </WebPartsTemplate>
    </asp:DeclarativeCatalogPart> 
    <asp:PageCatalogPart ID="PageCatalogPart1"
 runat="server" />
    <asp:ImportCatalogPart ID="ImportCatalogPart1"
 runat="server" /> 
  </ZoneTemplate>
</asp:CatalogZone>
<hr />
<asp:CatalogZone ID="CatalogZone2" runat="server"
  BorderWidth="2"
  HeaderText="My Empty CatalogZone"
  EmptyZoneText="No controls are in the zone." />

C#

<asp:CatalogZone ID="CatalogZone1" runat="server"
  EmptyZoneText="No controls are in the zone."
  HeaderText="My Web Parts Catalog"
  InstructionText="Add Web Parts controls to the zone."
  PartLinkStyle-Font-Italic="true"
  SelectedPartLinkStyle-Font-Bold="true"
  SelectTargetZoneText="Select zone"
  AddVerb-Text="Add Control"
  CloseVerb-Description="Close and return to browse mode."
 
  SelectedCatalogPartID="Currently Selected CatalogPart ID.">
  <ZoneTemplate>
    <asp:DeclarativeCatalogPart ID="DeclarativeCatalogPart1" 
      runat="server">
      <WebPartsTemplate>
        <aspSample:TextDisplayWebPart 
          runat="server"   
          id="textwebpart" 
          title = "Text Content WebPart" 
          ExportMode="All"/>  
        <asp:Calendar id="calendar1" runat="server" 
          title="My Calendar" />               
      </WebPartsTemplate>
    </asp:DeclarativeCatalogPart> 
    <asp:PageCatalogPart ID="PageCatalogPart1" runat="server"
 />
    <asp:ImportCatalogPart ID="ImportCatalogPart1" runat="server"
 /> 
  </ZoneTemplate>
</asp:CatalogZone>
<hr />
<asp:CatalogZone ID="CatalogZone2" runat="server"
  BorderWidth="2"
  HeaderText="My Empty CatalogZone"
  EmptyZoneText="No controls are in the zone." />

コード例の 2 番目の部分では、1 つ目のゾーンの InstructionText プロパティの値がプログラムによって別の値に代入されています。

Visual Basic

Protected Sub Button3_Click(ByVal
 sender As Object, _
  ByVal e As EventArgs)
  CatalogZone1.SelectTargetZoneText = "Add to zone"
  CatalogZone1.EmptyZoneText = "Zone is empty"
  CatalogZone1.HeaderText = "My Updated Header"
  CatalogZone1.InstructionText = "My Updated Instructions"
End Sub

C#

protected void Button3_Click(object sender,
 EventArgs e)
{
  CatalogZone1.SelectTargetZoneText = "Add to zone";
  CatalogZone1.EmptyZoneText = "Zone is empty";
  CatalogZone1.HeaderText = "My Updated Header";
  CatalogZone1.InstructionText = "My Updated Instructions";
}

ブラウザでページを読み込む場合、ドロップダウン リスト コントロールの [カタログ] を選択して、カタログ表示モードに切り替えることができます。カタログが表示されると、各ゾーンのヘッダー領域に InstructionText プロパティの値が表示されているのを確認できます。[Set Zone Text Properties] ボタンをクリックして、上のゾーンの InstructionText プロパティを、コードで代入されていた値に設定できます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
CatalogZoneBase クラス
CatalogZoneBase メンバ
System.Web.UI.WebControls.WebParts 名前空間
InstructionText
その他の技術情報
ASP.NET Web パーツ ページ