Literal.Mode プロパティ

リファレンス

定義

名前空間:: System.Web.UI.WebControls

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

Literal コントロールの内容を表示する方法を指定する列挙体の値を取得または設定します。

public:
 property System::Web::UI::WebControls::LiteralMode Mode { System::Web::UI::WebControls::LiteralMode get(); void set(System::Web::UI::WebControls::LiteralMode value); };

public System.Web.UI.WebControls.LiteralMode Mode { get; set; }

member this.Mode : System.Web.UI.WebControls.LiteralMode with get, set

Public Property Mode As LiteralMode

プロパティ値

LiteralMode

LiteralMode 列挙値のいずれか。既定値は、Transform です。

例外

ArgumentOutOfRangeException

指定した型が LiteralMode 列挙値ではありません。

例

次のコード例は、コントロールModeのプロパティを設定する方法をLiteral示しています。プロパティは Mode 、最初はコントロールの宣言構文で設定 Encode されます。ページが読み込まれた後、ユーザーはボタンをクリックしてプロパティPassThroughを Mode . これにより、プロパティの内容が Text 異なる方法でレンダリングされます。

注意

次の例では、単一ファイルのコードモデルを使用します。分離コードファイルに直接コピーすると、正しく動作しない可能性があります。このコード例は、拡張子が .aspx の空のテキストファイルにコピーする必要があります。 Web Forms コードモデルの詳細については、「ASP.NET Web Forms ページコードモデル」を参照してください。

<%@ Page Language="VB" %>

<!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>
    <title>Literal.Mode Property Example</title>
<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>

注釈

このプロパティを Mode 使用して、コントロールの内容をレンダリングする方法を Literal 指定します。このプロパティは、列挙値のいずれかを使用して設定されます LiteralMode 。次の表に、使用可能な値を示します。

値	説明
`PassThrough`	コントロールの内容は変更されません。
`Encode`	コントロールの内容は、HTML でエンコードされた文字列に変換されます。
`Transform`	サポートされていないマークアップ言語要素は、コントロールの内容から削除されます。 Literal HTML または XHTML をサポートするブラウザーでコントロールがレンダリングされる場合、コントロールの内容は変更されません。

指定 PassThroughすると、プロパティの Text 内容全体が、変更を加えずにデバイスまたはブラウザーに渡されます。たとえば、コントロールのLiteralプロパティにTextタグが含まれている<hr>場合、サポートされているかどうかに関係なく、すべてのデバイスとブラウザーに送信されます。

指定 Encodeした場合、プロパティの Text 内容は、レンダリングの前に HTML でエンコードされた文字列に変換されます。たとえば、コントロールのプロパティにTextタグが含まれている<hr>場合、そのプロパティはデバイスまたはブラウザーに<Hr>変換されて送信Literalされます。

指定 Transformした場合、プロパティのレンダリング動作は Text 、レンダリングされるマークアップの種類によって異なります。 HTML または XHTML を Literal サポートするデバイスまたはブラウザーに対してコントロールをレンダリングする場合、指定すると Transform 指定と同じ動作 PassThroughが生成されます。プロパティのすべてのマークアップタグと要素 Text は、要求するブラウザーに対してレンダリングされます。

Literal WML や cHTML など、HTML または XHTML 以外のマークアップ言語に対してコントロールをレンダリングする場合は、この値をTransform使用してサポートされていないマークアップ要素を削除できます。この場合、対象となるマークアップ言語でサポートされていないプロパティの Text マークアップ言語要素は、コントロールに対してレンダリングされません。たとえば、コントロールのLiteralプロパティにTextタグが含まれている<hr>場合、コンテンツが WML デバイスに送信される前にタグが削除されます。サポートされていないタグにコンテンツが含まれている場合、タグのみが削除され、コンテンツがデバイスまたはブラウザーに送信されます。たとえば、プロパティにコンテンツ<XYZ>Test</XYZ>がText含まれている場合、<XYZ>タグと</XYZ>タグは削除され、"Test" というテキストがデバイスまたはブラウザーに送信されます。

適用対象

Literal.Mode プロパティ

定義

プロパティ値

例外

例

注釈

適用対象

こちらもご覧ください

その他のリソース