Literal.Mode プロパティ
アセンブリ: System.Web (system.web.dll 内)
構文/** @property */ public LiteralMode get_Mode () /** @property */ public void set_Mode (LiteralMode value)
LiteralMode 列挙値の 1 つ。既定値は Transform です。
例外解説Mode プロパティを使用して、Literal コントロールの内容を表示する方法を指定します。このプロパティは、LiteralMode 列挙値の 1 つを使用して設定します。有効値の一覧を次の表に示します。
| 値 | |
|---|---|
| サポートされないマークアップ言語要素はコントロールの内容から削除されます。Literal コントロールが HTML または XHTML をサポートするブラウザに表示される場合は、コントロールの内容は変更されません。 |
PassThrough を指定すると、Text プロパティのすべての内容は、変更されずにデバイスまたはブラウザに渡されます。たとえば、Literal コントロールの Text プロパティに <hr> タグが含まれている場合、それがサポートされるかどうかにかかわらず、そのプロパティの内容がすべてのデバイスとブラウザに送信されます。
Encode を指定すると、Text プロパティの内容は、表示前に HTML エンコードされた文字列に変換されます。たとえば、Literal コントロールの Text プロパティに <hr> タグが含まれている場合、そのプロパティの内容は <Hr> に変換されてからデバイスまたはブラウザに送信されます。
Transform を指定すると、Text プロパティの表示動作は、表示されているマークアップの種類によって変わります。HTML または XHTML をサポートするデバイスまたはブラウザで Literal コントロールを表示する場合は、Transform を指定すると PassThrough を指定した場合と同じ動作になります。Text プロパティのすべてのマークアップ タグと要素は、要求側ブラウザで表示されます。
HTML や XHTML 以外のマークアップ言語 (WML や cHTML など) で Literal コントロールを表示する場合は、Transform 値を使用してサポートされていないマークアップ要素を削除できます。この場合、目的のマークアップ言語でサポートされていない Text プロパティのマークアップ言語要素は、このコントロールでは表示されません。たとえば、Literal コントロールの Text プロパティに <hr> タグが含まれている場合、内容が WML デバイスに送信される前にそのタグが削除されます。サポートされないタグに内容が含まれている場合は、タグだけが削除され、内容はデバイスまたはブラウザに送信されます。たとえば、Text プロパティに <XYZ>Test</XYZ> という内容が含まれている場合、<XYZ> タグと </XYZ> タグは削除され、テキスト "Test" はデバイスまたはブラウザに送信されます。
使用例Literal コントロールの Mode プロパティを設定する方法のコード例を次に示します。Mode プロパティは最初に、このコントロールの宣言構文で Encode に設定されます。ページが読み込まれると、ユーザーがボタンをクリックして、Mode プロパティを PassThrough に設定できます。これにより、Text プロパティの内容の表示方法が変わります。
.gif) メモ |
|---|
| 次のコード サンプルはシングルファイル コード モデルを使用しており、分離コード ファイルに直接コピーされた場合は正常に動作しない可能性があります。このコード サンプルは、拡張子が .aspx の空のテキスト ファイルにコピーする必要があります。Web フォームのコード モデルの詳細については、「ASP.NET Web ページのコード モデル」を参照してください。 |
<%@ Page Language="VB" %> <html> <head> <script runat=Server> Sub PassThroughButton_Click(ByVal sender As Object, ByVal e As EventArgs) Literal1.Mode = LiteralMode.PassThrough Label1.Text = "The contents of the Literal.Text property " + _ "passed through to the browser:" End Sub </script> </head> <body> <form ID="Form1" runat="server"> <h3>Literal.Mode Property Example</h3> <asp:Label ID="Label1" Text="The HTML-encoded contents of the Literal.Text property:" runat=Server> </asp:Label><br /><br /> <asp:Literal ID="Literal1" Mode=Encode Text= "<b>bold</b><br/><i>italic</i><br/>" runat=Server> </asp:Literal> <hr /> <asp:Button ID="PassThroughButton" Text="Pass Through Mode" OnClick="PassThroughButton_Click" runat=Server> </asp:Button> </form> </body> </html>
プラットフォームWindows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照LiteralMode 列挙体
アセンブリ: System.Web (system.web.dll 内)
構文Public Enumeration LiteralMode
メンバ| メンバ名 | 説明 | |
|---|---|---|
| Encode | リテラル コントロールの内容は HTML エンコードされます。 | |
| PassThrough | リテラル コントロールの内容は変更されません。 | |
| Transform | リテラル コントロールのサポートされないマークアップ言語要素は削除されます。リテラル コントロールが HTML または XHTML をサポートするブラウザに表示される場合は、コントロールの内容は変更されません。 |
解説LiteralMode 列挙体は、Literal コントロールの内容を表示する方法について指定できるモードを表します。Mode プロパティはこれらの列挙体の値を使用して、Literal コントロールの Text プロパティの内容の動作を設定します。
PassThrough を指定すると、Text プロパティのすべての内容は、変更されずにデバイスまたはブラウザに渡されます。たとえば、Literal コントロールの Text プロパティに <hr> タグが含まれている場合、それがサポートされるかどうかにかかわらず、そのプロパティの内容がすべてのデバイスとブラウザに送信されます。
Encode を指定すると、Text プロパティの内容は、表示前に HTML エンコードされた文字列に変換されます。たとえば、Literal コントロールの Text プロパティに <hr> タグが含まれている場合、そのプロパティの内容は <hr> に変換されてからデバイスまたはブラウザに送信されます。
Transform を指定すると、Text プロパティの表示動作は、表示されているマークアップの種類によって変わります。HTML または XHTML をサポートするデバイスまたはブラウザで Literal コントロールを表示する場合は、Transform を指定すると PassThrough を指定した場合と同じ動作になります。Text プロパティのすべてのマークアップ タグと要素は、要求側ブラウザで表示されます。
HTML や XHTML 以外のマークアップ言語 (WML や cHTML など) で Literal コントロールを表示する場合は、Transform 値を使用してサポートされていないマークアップ要素を削除できます。この場合、目的のマークアップ言語でサポートされていない Text プロパティのマークアップ言語要素は、このコントロールでは表示されません。たとえば、Literal コントロールの Text プロパティに <hr> タグが含まれている場合、内容が WML デバイスに送信される前にそのタグが削除されます。サポートされないタグに内容が含まれている場合は、タグだけが削除され、内容はデバイスまたはブラウザに送信されます。たとえば、Text プロパティに <XYZ>Test</XYZ> という内容が含まれている場合、<XYZ> タグと </XYZ> タグは削除されますが、テキスト Test はデバイスまたはブラウザに送信されます。
使用例Literal コントロールの Mode プロパティを設定する方法のコード例を次に示します。Mode プロパティは最初に、このコントロールの宣言構文で Encode に設定されます。ページが読み込まれると、ユーザーがボタンをクリックして、Mode プロパティを PassThrough に設定できます。これにより、Text プロパティの内容の表示方法が変わります。
<%@ Page Language="VB" %> <html> <head> <script runat=Server> Sub PassThroughButton_Click(ByVal sender As Object, ByVal e As EventArgs) Literal1.Mode = LiteralMode.PassThrough Label1.Text = "The contents of the Literal.Text property " + _ "passed through to the browser:" End Sub </script> </head> <body> <form ID="Form1" runat="server"> <h3>Literal.Mode Property Example</h3> <asp:Label ID="Label1" Text="The HTML-encoded contents of the Literal.Text property:" runat=Server> </asp:Label><br /><br /> <asp:Literal ID="Literal1" Mode=Encode Text= "<b>bold</b><br/><i>italic</i><br/>" runat=Server> </asp:Literal> <hr /> <asp:Button ID="PassThroughButton" Text="Pass Through Mode" OnClick="PassThroughButton_Click" runat=Server> </asp:Button> </form> </body> </html>
プラットフォームWindows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
バージョン情報参照- LiteralModeのページへのリンク
