Export (0) Print
Expand All
Expand Minimize

LiteralMode Enumeration

Specifies how the content in a Literal control is rendered.

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public enum LiteralMode

Member nameDescription
EncodeThe literal control's contents are HTML-encoded.
PassThroughThe literal control's contents are not modified.
TransformThe literal control's unsupported markup-language elements are removed. If the literal control is rendered on a browser that supports HTML or XHTML, the control's contents are not modified.

The LiteralMode enumeration represents the modes that you can specify for how the content in a Literal control is rendered. The Mode property uses these enumeration values to set the behavior of the contents of the Text property in a Literal control.

If you specify PassThrough, the entire contents of the Text property are passed to the device or browser without any modifications. For example, if the Text property of a Literal control contains an <hr> tag, it is sent to all devices and browsers regardless of whether it is supported.

If you specify Encode, the contents for the Text property are converted into an HTML-encoded string before rendering. For example, if the Text property of a Literal control contains an <hr> tag, it will be converted to &lt;hr&gt; and sent to the device or browser.

If you specify Transform, the rendering behavior of the Text property depends on the type of markup being rendered. When the Literal control is rendered for a device or browser that supports HTML or XHTML, specifying Transform produces the same behavior as specifying PassThrough. All markup tags and elements for the Text property are rendered for the requesting browser.

When the Literal control is rendered for a markup language other than HTML or XHTML, such as WML or cHTML, you can use the Transform value to remove unsupported markup elements. In this case, any markup-language elements of the Text property that are not supported in the targeted markup language are not rendered for the control. For example, if the Text property of a Literal control contains an <hr> tag, the tag is removed before the content is sent to a WML device. If an unsupported tag contains content, only the tag is removed and the content is sent to the device or browser. For example, if the Text property contains the content <XYZ>Test</XYZ>, the <XYZ> and </XYZ> tags are removed while the text Test is sent to the device or browser.

TopicLocation
How to: Add Literal Web Server Controls to a Web Forms PageBuilding ASP .NET Web Applications
How to: Add Literal Web Server Controls to a Web Forms PageBuilding ASP .NET Web Applications
How to: Add Literal Web Server Controls to a Web Forms Page (Visual Studio)Building ASP .NET Web Applications in Visual Studio

The following code example demonstrates how to set a Literal control's Mode property. The Mode property is initially set to Encode in the declarative syntax for the control. After the page loads, the user can click a button to set the Mode property to PassThrough. This causes the contents of the Text property to render differently.

<%@ 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>

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft