ToolZone.InstructionText プロパティ
アセンブリ: System.Web (system.web.dll 内)

Dim instance As ToolZone Dim value As String value = instance.InstructionText instance.InstructionText = value
[LocalizableAttribute(true)] public: virtual property String^ InstructionText { String^ get (); void set (String^ value); }
/** @property */ public String get_InstructionText () /** @property */ public void set_InstructionText (String value)
public function get InstructionText () : String public function set InstructionText (value : String)
エンド ユーザーのための利用手順が含まれている文字列。特定のツール ゾーンに対して適切となる既定値は、派生した ToolZone クラスによって提供されます。

InstructionText プロパティは、特定の ToolZone コントロールが表示されたときに、エンド ユーザーに提供される一連の手順を格納するために使用されます。
このプロパティの値は、設定時に、デザイナ ツールを使用してリソース ファイルに自動的に保存できます。詳細については、LocalizableAttribute、ASP.NET のグローバリゼーションおよびローカリゼーション の各トピックを参照してください。
継承時の注意 ToolZone クラスから派生する Web パーツ コントロール セットのツール ゾーン (ToolZone クラスの概要トピックで列挙されているゾーンを参照してください) は、InstructionText プロパティをオーバーライドしてエンド ユーザーに既定の手順を提供します。
継承された ToolZone コントロールで InstructionText プロパティを使用する方法を次のコード例に示します。この例では、このプロパティを使用して、EditorZone コントロール内に表示される手順のテキストの値を変更する方法について示しています。
コード例の最初の部分は、ページで参照されるユーザー コントロールであり、これによってページを他の表示モードに切り替えられるようになります。表示モード、およびユーザーが表示モードを切り替えられるようにする方法の詳細については、「チュートリアル : Web パーツ ページでの表示モードの変更」を参照してください。
<%@ control language="vb" classname="DisplayModeMenuVB"%> <script runat="server"> ' Use a field to reference the current WebPartManager. Dim _manager As WebPartManager Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs) AddHandler Page.InitComplete, AddressOf InitComplete End Sub Sub InitComplete(ByVal sender As Object, ByVal e As System.EventArgs) _manager = WebPartManager.GetCurrentWebPartManager(Page) Dim browseModeName As String = WebPartManager.BrowseDisplayMode.Name ' Fill the dropdown with the names of supported display modes. Dim mode As WebPartDisplayMode For Each mode In _manager.SupportedDisplayModes Dim modeName As String = mode.Name ' Make sure a mode is enabled before adding it. If mode.IsEnabled(_manager) Then Dim item As New ListItem(modeName, modeName) DisplayModeDropdown.Items.Add(item) End If Next mode ' If shared scope is allowed for this user, display the scope-switching ' UI and select the appropriate radio button for the current user scope. If _manager.Personalization.CanEnterSharedScope Then Panel2.Visible = True If _manager.Personalization.Scope = PersonalizationScope.User Then RadioButton1.Checked = True Else RadioButton2.Checked = True End If End If End Sub ' Change the page to the selected display mode. Sub DisplayModeDropdown_SelectedIndexChanged(ByVal sender As Object, _ ByVal e As EventArgs) Dim selectedMode As String = DisplayModeDropdown.SelectedValue Dim mode As WebPartDisplayMode = _ _manager.SupportedDisplayModes(selectedMode) If Not (mode Is Nothing) Then _manager.DisplayMode = mode End If End Sub ' Set the selected item equal to the current display mode. Sub Page_PreRender(ByVal sender As Object, ByVal e As EventArgs) Dim items As ListItemCollection = DisplayModeDropdown.Items Dim selectedIndex As Integer = _ items.IndexOf(items.FindByText(_manager.DisplayMode.Name)) DisplayModeDropdown.SelectedIndex = selectedIndex End Sub ' Reset all of a user's personalization data for the page. Protected Sub LinkButton1_Click(ByVal sender As Object, _ ByVal e As EventArgs) _manager.Personalization.ResetPersonalizationState() End Sub ' If not in User personalization scope, toggle into it. Protected Sub RadioButton1_CheckedChanged(ByVal sender As Object, _ ByVal e As EventArgs) If _manager.Personalization.Scope = PersonalizationScope.Shared Then _manager.Personalization.ToggleScope() End If End Sub ' If not in Shared scope, and if user is allowed, toggle the scope. Protected Sub RadioButton2_CheckedChanged(ByVal sender As Object, _ ByVal e As EventArgs) If _manager.Personalization.CanEnterSharedScope AndAlso _ _manager.Personalization.Scope = PersonalizationScope.User Then _manager.Personalization.ToggleScope() End If End Sub </script> <div> <asp:Panel ID="Panel1" runat="server" Borderwidth="1" Width="230" BackColor="lightgray" Font-Names="Verdana, Arial, Sans Serif" > <asp:Label ID="Label1" runat="server" Text=" Display Mode" Font-Bold="true" Font-Size="8" Width="120" /> <asp:DropDownList ID="DisplayModeDropdown" runat="server" AutoPostBack="true" Width="120" OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" /> <asp:LinkButton ID="LinkButton1" runat="server" Text="Reset User State" ToolTip="Reset the current user's personalization data for the page." Font-Size="8" OnClick="LinkButton1_Click" /> <asp:Panel ID="Panel2" runat="server" GroupingText="Personalization Scope" Font-Bold="true" Font-Size="8" Visible="false" > <asp:RadioButton ID="RadioButton1" runat="server" Text="User" AutoPostBack="true" GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" /> <asp:RadioButton ID="RadioButton2" runat="server" Text="Shared" AutoPostBack="true" GroupName="Scope" OnCheckedChanged="RadioButton2_CheckedChanged" /> </asp:Panel> </asp:Panel> </div>
<%@ control language="C#" classname="DisplayModeMenuCS"%> <script runat="server"> // Use a field to reference the current WebPartManager. WebPartManager _manager; void Page_Init(object sender, EventArgs e) { Page.InitComplete += new EventHandler(InitComplete); } void InitComplete(object sender, System.EventArgs e) { _manager = WebPartManager.GetCurrentWebPartManager(Page); String browseModeName = WebPartManager.BrowseDisplayMode.Name; // Fill the dropdown with the names of supported display modes. foreach (WebPartDisplayMode mode in _manager.SupportedDisplayModes) { String modeName = mode.Name; // Make sure a mode is enabled before adding it. if (mode.IsEnabled(_manager)) { ListItem item = new ListItem(modeName, modeName); DisplayModeDropdown.Items.Add(item); } } // If shared scope is allowed for this user, display the scope-switching // UI and select the appropriate radio button for the current user scope. if (_manager.Personalization.CanEnterSharedScope) { Panel2.Visible = true; if (_manager.Personalization.Scope == PersonalizationScope.User) RadioButton1.Checked = true; else RadioButton2.Checked = true; } } // Change the page to the selected display mode. void DisplayModeDropdown_SelectedIndexChanged(object sender, EventArgs e) { String selectedMode = DisplayModeDropdown.SelectedValue; WebPartDisplayMode mode = _manager.SupportedDisplayModes[selectedMode]; if (mode != null) _manager.DisplayMode = mode; } // Set the selected item equal to the current display mode. void Page_PreRender(object sender, EventArgs e) { ListItemCollection items = DisplayModeDropdown.Items; int selectedIndex = items.IndexOf(items.FindByText(_manager.DisplayMode.Name)); DisplayModeDropdown.SelectedIndex = selectedIndex; } // Reset all of a user's personalization data for the page. protected void LinkButton1_Click(object sender, EventArgs e) { _manager.Personalization.ResetPersonalizationState(); } // If not in User personalization scope, toggle into it. protected void RadioButton1_CheckedChanged(object sender, EventArgs e) { if (_manager.Personalization.Scope == PersonalizationScope.Shared) _manager.Personalization.ToggleScope(); } // If not in Shared scope, and if user is allowed, toggle the scope. protected void RadioButton2_CheckedChanged(object sender, EventArgs e) { if (_manager.Personalization.CanEnterSharedScope && _manager.Personalization.Scope == PersonalizationScope.User) _manager.Personalization.ToggleScope(); } </script> <div> <asp:Panel ID="Panel1" runat="server" Borderwidth="1" Width="230" BackColor="lightgray" Font-Names="Verdana, Arial, Sans Serif" > <asp:Label ID="Label1" runat="server" Text=" Display Mode" Font-Bold="true" Font-Size="8" Width="120" /> <asp:DropDownList ID="DisplayModeDropdown" runat="server" AutoPostBack="true" Width="120" OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" /> <asp:LinkButton ID="LinkButton1" runat="server" Text="Reset User State" ToolTip="Reset the current user's personalization data for the page." Font-Size="8" OnClick="LinkButton1_Click" /> <asp:Panel ID="Panel2" runat="server" GroupingText="Personalization Scope" Font-Bold="true" Font-Size="8" Visible="false" > <asp:RadioButton ID="RadioButton1" runat="server" Text="User" AutoPostBack="true" GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" /> <asp:RadioButton ID="RadioButton2" runat="server" Text="Shared" AutoPostBack="true" GroupName="Scope" OnCheckedChanged="RadioButton2_CheckedChanged" /> </asp:Panel> </asp:Panel> </div>
コード例の 2 番目の部分には、Button1_Click メソッドのプロパティをプログラムで更新するためのコードを含む部分クラスが示されています。
Imports System Imports System.Web Imports System.Web.UI Imports System.Web.UI.WebControls Imports System.Web.UI.WebControls.WebParts Partial Public Class Toolzone_overview_vb Inherits System.Web.UI.Page Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs) If TextBox1.Text = String.Empty Or TextBox1.Text.Length < 0 Then EditorZone1.InstructionText = String.Empty Else EditorZone1.InstructionText = Server.HtmlEncode(TextBox1.Text) End If TextBox1.Text = String.Empty End Sub End Class
using System; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using System.Web.UI.WebControls.WebParts; public partial class Toolzone_overview_cs : System.Web.UI.Page { protected void Button1_Click(Object sender, EventArgs e) { if(TextBox1.Text == String.Empty | TextBox1.Text.Length < 0) EditorZone1.InstructionText = String.Empty; else EditorZone1.InstructionText = Server.HtmlEncode(TextBox1.Text); TextBox1.Text = String.Empty; } }
コード例の 3 番目の部分には、2 つの継承された ToolZone コントロール (CatalogZone コントロールおよび EditorZone コントロール) が含まれる Web ページが示されています。各 ToolZone コントロールは、ページの宣言型マークアップの複数のプロパティを設定します。
<%@ Page Language="VB" Codefile="Toolzone_overview.vb" Inherits="Toolzone_overview_vb" %> <%@ register TagPrefix="uc1" TagName="DisplayModeMenuVB" Src="DisplayModeMenuVB.ascx" %> <html > <head runat="server"> <title>Tool Zone Example</title> </head> <body> <form id="form1" runat="server"> <div> <asp:WebPartManager ID="WebPartManager1" Runat="server" /> <uc1:DisplayModeMenuVB ID="DisplayModeMenu1" runat="server" /> <asp:WebPartZone ID="WebPartZone1" Runat="server" > <ZoneTemplate> <asp:BulletedList ID="BulletedList1" Runat="server" DisplayMode="HyperLink" Title="Favorite Links" > <asp:ListItem Value="http://msdn.microsoft.com">MSDN</asp:ListItem> <asp:ListItem Value="http://www.asp.net">ASP.NET</asp:ListItem> <asp:ListItem Value="http://www.msn.com">MSN</asp:ListItem> </asp:BulletedList> </ZoneTemplate> </asp:WebPartZone> <asp:EditorZone ID="EditorZone1" Runat="server"> <HeaderVerbStyle Font-Underline="true" /> <ZoneTemplate> <asp:AppearanceEditorPart ID="AppearanceEditorPart1" Runat="server" /> <asp:LayoutEditorPart ID="LayoutEditorPart1" Runat="server" /> </ZoneTemplate> </asp:EditorZone> <asp:CatalogZone ID="CatalogZone1" Runat="server"> <LabelStyle Font-Italic="true" /> <ZoneTemplate> <asp:DeclarativeCatalogPart ID="DeclarativeCatalogPart1" Runat="server"> <WebPartsTemplate> <asp:Calendar ID="Calendar1" Runat="server" Title="My Calendar" /> </WebPartsTemplate> </asp:DeclarativeCatalogPart> </ZoneTemplate> </asp:CatalogZone> <asp:Button ID="Button1" Runat="server" Text="Update Edit Zone Text" OnClick="Button1_Click" /> <asp:TextBox ID="TextBox1" Runat="server"></asp:TextBox> </div> </form> </body> </html>
<%@ Page Language="C#" Codefile="Toolzone_overview.cs" Inherits="Toolzone_overview_cs" %> <%@ register TagPrefix="uc1" TagName="DisplayModeMenuCS" Src="DisplayModeMenuCS.ascx" %> <html > <head runat="server"> <title>Tool Zone Example</title> </head> <body> <form id="form1" runat="server"> <div> <asp:WebPartManager ID="WebPartManager1" Runat="server" /> <uc1:DisplayModeMenuCS ID="DisplayModeMenu1" runat="server" /> <asp:WebPartZone ID="WebPartZone1" Runat="server" > <ZoneTemplate> <asp:BulletedList ID="BulletedList1" Runat="server" DisplayMode="HyperLink" Title="Favorite Links" > <asp:ListItem Value="http://msdn.microsoft.com">MSDN</asp:ListItem> <asp:ListItem Value="http://www.asp.net">ASP.NET</asp:ListItem> <asp:ListItem Value="http://www.msn.com">MSN</asp:ListItem> </asp:BulletedList> </ZoneTemplate> </asp:WebPartZone> <asp:EditorZone ID="EditorZone1" Runat="server"> <HeaderVerbStyle Font-Underline="true" /> <ZoneTemplate> <asp:AppearanceEditorPart ID="AppearanceEditorPart1" Runat="server" /> <asp:LayoutEditorPart ID="LayoutEditorPart1" Runat="server" /> </ZoneTemplate> </asp:EditorZone> <asp:CatalogZone ID="CatalogZone1" Runat="server"> <LabelStyle Font-Italic="true" /> <ZoneTemplate> <asp:DeclarativeCatalogPart ID="DeclarativeCatalogPart1" Runat="server"> <WebPartsTemplate> <asp:Calendar ID="Calendar1" Runat="server" Title="My Calendar" /> </WebPartsTemplate> </asp:DeclarativeCatalogPart> </ZoneTemplate> </asp:CatalogZone> <asp:Button ID="Button1" Runat="server" Text="Update Edit Zone Text" OnClick="Button1_Click" /> <asp:TextBox ID="TextBox1" Runat="server"></asp:TextBox> </div> </form> </body> </html>
ブラウザでページを読み込み、さまざまなページ表示モードに切り替えると、ツール ゾーンの動作の違いを確認できます。ページを編集モードに切り替え、テキスト ボックスにテキストを入力し、次に [Update Edit Zone Text] をクリックして、プログラムによって更新された 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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


Weblioに収録されているすべての辞書からToolZone.InstructionText プロパティを検索する場合は、下記のリンクをクリックしてください。

- ToolZone.InstructionText プロパティのページへのリンク