XhtmlTextWriter XhtmlTextWriter XhtmlTextWriter XhtmlTextWriter Class

Definition

Writes Extensible Hypertext Markup Language (XHTML)-specific characters, including all variations of XHTML modules that derive from XTHML, to the output stream for an ASP.NET server control for mobile devices. Override the XhtmlTextWriter class to provide custom XHTML rendering for ASP.NET pages and server controls.

public ref class XhtmlTextWriter : System::Web::UI::HtmlTextWriter
public class XhtmlTextWriter : System.Web.UI.HtmlTextWriter
type XhtmlTextWriter = class
    inherit HtmlTextWriter
Public Class XhtmlTextWriter
Inherits HtmlTextWriter
Inheritance

Examples

The code example in this section contains four parts. The first example demonstrates how to create a derived class. The second code example demonstrates how to create a custom control. The third code example demonstrates how to use the custom control. The fourth code example provides the code that is required to run the custom control.

The following code example demonstrates how to create a custom class that is derived from the XhtmlTextWriter class. It has two constructors, which is standard for all classes that inherit directly or indirectly from the HtmlTextWriter class. The first constructor takes a TextWriter object as a parameter and calls the second constructor, passing the following two parameter values:

This code example also shows how to override the OnAttributeRender and OnStyleAttributeRender methods to filter for text size and color style, respectively. Additionally, it overrides the BeginRender and EndRender methods to write a text string before and after a control has rendered.

using System;
using System.IO;
using System.Web;
using System.Security.Permissions;
using System.Web.UI;
using System.Web.UI.Adapters;
using System.Web.UI.WebControls.Adapters;

namespace Samples.AspNet.CS
{
    // Create a class that inherits from XhtmlTextWriter.
    [AspNetHostingPermission(SecurityAction.Demand, 
        Level=AspNetHostingPermissionLevel.Minimal)]
    [AspNetHostingPermission(SecurityAction.InheritanceDemand, 
        Level=AspNetHostingPermissionLevel.Minimal)] 
    public class CustomXhtmlTextWriter : XhtmlTextWriter
    {
        // Create two constructors, following 
        // the pattern for implementing a
        // TextWriter constructor.
        public CustomXhtmlTextWriter(TextWriter writer) : 
            this(writer, DefaultTabString)
        {
        }


        public CustomXhtmlTextWriter(TextWriter writer, string tabString) : 
            base(writer, tabString)
        {
        }


        // Override the OnAttributeRender method to 
        // allow this text writer to render only eight-point 
        // text size.
        protected override bool OnAttributeRender(string name, 
          string value, 
          HtmlTextWriterAttribute key) 
        {
            if (key == HtmlTextWriterAttribute.Size)
            {
                if (String.Compare(value, "8pt") == 0)
                {
                    return true;
                }
                else
                {
                   return false;
                } 
             }
             else
             {
                 return base.OnAttributeRender(name, value, key);
             }

         }
        
        // Override the OnStyleAttributeRender
        // method to prevent this text writer 
        // from rendering purple text.
        protected override bool OnStyleAttributeRender(string name, 
            string value, 
            HtmlTextWriterStyle key)
        {
            if (key == HtmlTextWriterStyle.Color)
            {
                if (String.Compare(value, "purple") == 0)
                {
                    return false;
                }
                else
                {
                    return true;
                }
            }
            else
            {
                return base.OnStyleAttributeRender(name, value, key);
            }        
        }  

        // Override the BeginRender method to write a
        // message and call the WriteBreak method
        // before a control is rendered.
        override public void BeginRender()
        {
           this.Write("A control is about to render.");
           this.WriteBreak();
        }
        
        // Override the EndRender method to
        // write a string immediately after 
        // a control has rendered. 
        override public void EndRender()
        {
           this.Write("A control just rendered.");
        }  
         
    }
}
Imports System
Imports System.IO
Imports System.Web
Imports System.Security.Permissions
Imports System.Web.UI
Imports System.Web.UI.Adapters
Imports System.Web.UI.WebControls.Adapters

Namespace Samples.AspNet.VB

    ' Create a class that inherits from XhtmlTextWriter.
    <AspNetHostingPermission(SecurityAction.Demand, _
        Level:=AspNetHostingPermissionLevel.Minimal)> _
    <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
        Level:=AspNetHostingPermissionLevel.Minimal)> _
    Public Class CustomXhtmlTextWriter
        Inherits XhtmlTextWriter

        ' Create two constructors, following 
        ' the pattern for implementing a
        ' TextWriter constructor.
        Public Sub New(writer As TextWriter)
          MyClass.New(writer, DefaultTabString)
        End Sub 'New


        Public Sub New(writer As TextWriter, tabString As String)
          MyBase.New(writer, tabString)
        End Sub 'New


        ' Override the OnAttributeRender method to 
        ' allow this text writer to render only eight-point 
        ' text size.
        Overrides Protected Function OnAttributeRender(ByVal name As String, _
          ByVal value As String, _
          ByVal key As HtmlTextWriterAttribute _
        ) As Boolean
           If key = HtmlTextWriterAttribute.Size Then
              If String.Compare(value, "8pt") = 0 Then
                 Return True
              Else
                 Return False
              End If 
           Else
              Return MyBase.OnAttributeRender(name, value, key)
           End If
        End Function
        
        ' Override the OnStyleAttributeRender
        ' method to prevent this text writer 
        ' from rendering purple text.
        Overrides Protected Function OnStyleAttributeRender(ByVal name As String, _
          ByVal value As String, _
          ByVal key As HtmlTextWriterStyle _
        ) As Boolean
           If key = HtmlTextWriterStyle.Color Then
              If String.Compare(value, "purple") = 0 Then
                 Return False
              Else
                 Return True
              End If
           Else
              Return MyBase.OnStyleAttributeRender(name, value, key)        
           End If
        End Function  

        ' Override the BeginRender method to write a
        ' message and call the WriteBreak method
        ' before a control is rendered.
        Overrides Public Sub BeginRender()
           Me.Write("A control is about to render.")
           Me.WriteBreak()
        End Sub
        
        ' Override the EndRender method to
        ' write a string immediately after 
        ' a control has rendered. 
        Overrides Public Sub EndRender()
           Me.Write("A control just rendered.")
        End Sub  
         
    End Class
End Namespace

The following code example demonstrates how to create a custom Label control named TestLabel and a custom adapter named XhtmlTestLabelAdapter that renders the content of the control as XHTML.

using System;
using System.Web;
using System.Web.UI;
using System.Web.UI.Adapters;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.Adapters;

namespace AspNet.Samples
{
	// Create a simple class that inherits
    // from the Label class.
	public class TestLabel : Label
	{
		private String _textValue;

		// Override the Text property.
		public override string Text
		{
			get
			{
				return (string)ViewState["Text"];
			}
			set
			{
				ViewState["Text"] = value;
			}
		}
	}
	public class XhtmlTestLabelAdapter : WebControlAdapter
	{
		// Create a control property that accesses the
		// methods and properties of the control.
		protected TestLabel Control
		{
			get
			{
				return (TestLabel)base.Control;
			}
		}

		protected override void Render(HtmlTextWriter writer)
		{
			// Create an instance of the XhtmlTextWriter class,
			// named w, and cast the HtmlTextWriter passed 
			// in the writer parameter to w.
			XhtmlTextWriter w = new XhtmlTextWriter(writer);

			// Create a string variable, named value, to hold
			// the control's Text property value.
			String value = Control.Text;

			
            // Create a Boolean variable, named attTest,
            // to test whether the Style attribute is 
            // valid in the page that the control is
            // rendered to.
            Boolean attTest = w.IsValidFormAttribute("style");

            // Check whether attTest is true or false.
            // If true, a style is applied to the XHTML
            // content. If false, no style is applied.
			if (attTest)
				w.EnterStyle(Control.ControlStyle);

			// Write the Text property value of the control,
            // a <br> element, and a string. Consider encoding the value using WriteEncodedText.
            w.Write(value);
            w.WriteBreak();
            w.Write("This control conditionally rendered its styles for XHTML.");

            // Check whether attTest is true or false.
            // If true, the XHTML style is closed.
            // If false, nothing is rendered.
            if (attTest)
                w.ExitStyle(Control.ControlStyle);
		}

	}

}
Imports System
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.Adapters
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.Adapters

Namespace AspNet.Samples
    ' Create a simple class that inherits
    ' from the Label class.
    Public Class TestLabel
      Inherits Label

      Private textValue As String
      
      ' Override the Text property.
      Overrides Public Property Text As String
         Get
                Return CStr(ViewState("Text"))
         End Get
         
         Set
                ViewState("Text") = Value
         End Set
        End Property

    End Class
    ' Create a class to render the custom Label's
    ' content to XHTML devices.
    Public Class XhtmlTestLabelAdapter
         Inherits WebControlAdapter

   
      ' Create a Control property that accesses the 
      ' methods and properties of the control.
      Protected Shadows ReadOnly Property Control() As TestLabel
         Get
            Return CType(MyBase.Control, TestLabel)
         End Get
      End Property
   
        ' Override the Render method.
        Protected Overrides Sub Render(ByVal writer As HtmlTextWriter)

            ' Create an instance of the XhtmlTextWriter class, 
            ' named w, and cast the HtmlTextWriter passed 
            ' in the writer parameter to w.
            Dim w As XhtmlTextWriter = New XhtmlTextWriter(writer)

            ' Create a string variable, named value, to hold
            ' the control's Text property value.
            Dim value As String = Control.Text

            ' Create a Boolean variable, named attTest,
            ' to test whether the Style attribute is 
            ' valid in the page that the control is
            ' rendered to.
            Dim attTest As Boolean = w.IsValidFormAttribute("style")

            ' Check whether attTest is true or false.
            ' If true, a style is applied to the XHTML
            ' content. If false, no style is applied.
            If (attTest = True) Then
                w.EnterStyle(Control.ControlStyle)
            End If

            ' Write the Text property value of the control,
            ' a <br> element, and a string. Consider encoding the value using WriteEncodedText.
            w.Write(value)
            w.WriteBreak()
            w.Write("This control conditionally rendered its styles for XHTML.")

            ' Check whether attTest is true or false.
            ' If true, the XHTML style is closed.
            ' If false, nothing is rendered.
            If (attTest = True) Then
                w.ExitStyle(Control.ControlStyle)
            End If

        End Sub 'Render

    End Class
End Namespace

The following code example demonstrates how to use the custom control TestLabel on an ASP.NET Web page.

<%@ Page Language="C#" %>
<%@ Import Namespace="AspNet.Samples" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  protected void Page_Load(object sender, EventArgs e)
  {
    TestLabel tl = new TestLabel();
    tl.ID = "TestLabel1";
    PlaceHolder1.Controls.Add(tl);

  }
</script>


<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>XHtmlTextWriter Example</title>
</head>
<body>
    <form id="form1" runat="server" >
    <div>
      <asp:PlaceHolder ID="PlaceHolder1" runat="server"></asp:PlaceHolder>    
    </div>
    </form>
</body>
</html>
<%@ Page Language="VB"   %>
<%@ Import Namespace="AspNet.Samples" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)

    Dim tl As TestLabel = New TestLabel()
    tl.ID = "TestLabel1"
    PlaceHolder1.Controls.Add(tl)
    
  End Sub
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>XHtmlTextWriter Example</title>
</head>
<body>
    <form id="form1" runat="server" >
    <div>
      <asp:PlaceHolder ID="PlaceHolder1" runat="server"></asp:PlaceHolder>    
    </div>
    </form>
</body>
</html>

To use the custom control in the preceding code example, add the following <controlAdapters> element to one of two files. You can add it to the appropriate machine-wide file in the subdirectory for a specific browser, as a subfolder of the .NET Framework configuration directory. Alternatively, you can add it to a custom browser file in the App_Browsers directory under the Web application root.

<controlAdapters>  
   <adapter controlType="AspNet.Samples.TestLabel"  
   adapterType="AspNet.Samples.XhtmlTestLabelAdapter" />  
</controlAdapters>  

Remarks

XHTML is an XML-compliant markup language, based on HTML 4.1, which allows you to create Web sites that are suitable for multiple device types. It merges the ease of use provided by HTML with the strict element guidelines provided by XML to produce a markup language with a wide range of format and style options, and with reduced markup tag ambiguity. The XhtmlTextWriter class provides formatting capabilities that ASP.NET server controls use when rendering XHTML content to clients. You can use the SetDocType method to specify which type of XHTML the text writer renders. Supported document types are defined in the XhtmlMobileDocType enumeration.

The XhtmlTextWriter class renders two sets of attributes for elements. One set is a collection of common attributes, as referenced in the CommonAttributes property. The second set is a collection of element-specific attributes, as referenced in the ElementSpecificAttributes property. For more information on the elements and styles that are rendered, see the XHTML modularization specification at the World Wide Web Consortium (W3C) Web site.

You can use the members of the XhtmlTextWriter class and any derived classes to create custom text writers to use in custom XHTML page adapters or class adapters. You can also create derived classes that override the standard behavior of the XhtmlTextWriter class.

By default, when you are working with browsers that support HTML 4.0, ASP.NET pages and controls render markup that is compatible with the XHTML 1.1 standard. For more information, see XHTML Standards in Visual Studio and ASP.NET.

The HtmlTextWriter outputs XHTML unless you configure ASP.NET specifically to not render XHTML markup. For more information, see NIB: How to: Configure XHTML Rendering in ASP.NET Web Sites.

Constructors

XhtmlTextWriter(TextWriter) XhtmlTextWriter(TextWriter) XhtmlTextWriter(TextWriter) XhtmlTextWriter(TextWriter)

Initializes a new instance of the XhtmlTextWriter class that uses the line indentation that is specified in the DefaultTabString field. Use the XhtmlTextWriter(TextWriter) constructor if you do not want to change the default line indentation.

XhtmlTextWriter(TextWriter, String) XhtmlTextWriter(TextWriter, String) XhtmlTextWriter(TextWriter, String) XhtmlTextWriter(TextWriter, String)

Initializes a new instance of the XhtmlTextWriter class with the specified line indentation.

Properties

CommonAttributes CommonAttributes CommonAttributes CommonAttributes

Gets a Hashtable object containing common attributes of the markup tags for the XhtmlTextWriter object.

ElementSpecificAttributes ElementSpecificAttributes ElementSpecificAttributes ElementSpecificAttributes

Gets a Hashtable object containing element-specific attributes.

Encoding Encoding Encoding Encoding

Gets the encoding that the HtmlTextWriter object uses to write content to the page.

(Inherited from HtmlTextWriter)
FormatProvider FormatProvider FormatProvider FormatProvider

Gets an object that controls formatting.

(Inherited from TextWriter)
Indent Indent Indent Indent

Gets or sets the number of tab positions to indent the beginning of each line of markup.

(Inherited from HtmlTextWriter)
InnerWriter InnerWriter InnerWriter InnerWriter

Gets or sets the text writer that writes the inner content of the markup element.

(Inherited from HtmlTextWriter)
NewLine NewLine NewLine NewLine

Gets or sets the line terminator string used by the HtmlTextWriter object.

(Inherited from HtmlTextWriter)
SuppressCommonAttributes SuppressCommonAttributes SuppressCommonAttributes SuppressCommonAttributes

Gets a Hashtable object of elements for which CommonAttributes attributes are suppressed.

TagKey TagKey TagKey TagKey

Gets or sets the HtmlTextWriterTag value for the specified markup element.

(Inherited from HtmlTextWriter)
TagName TagName TagName TagName

Gets or sets the tag name of the markup element being rendered.

(Inherited from HtmlTextWriter)

Methods

AddAttribute(HtmlTextWriterAttribute, String) AddAttribute(HtmlTextWriterAttribute, String) AddAttribute(HtmlTextWriterAttribute, String) AddAttribute(HtmlTextWriterAttribute, String)

Adds the markup attribute and the attribute value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method.

(Inherited from HtmlTextWriter)
AddAttribute(HtmlTextWriterAttribute, String, Boolean) AddAttribute(HtmlTextWriterAttribute, String, Boolean) AddAttribute(HtmlTextWriterAttribute, String, Boolean) AddAttribute(HtmlTextWriterAttribute, String, Boolean)

Adds the markup attribute and the attribute value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method, with optional encoding.

(Inherited from HtmlTextWriter)
AddAttribute(String, String) AddAttribute(String, String) AddAttribute(String, String) AddAttribute(String, String)

Adds the specified markup attribute and value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method.

(Inherited from HtmlTextWriter)
AddAttribute(String, String, Boolean) AddAttribute(String, String, Boolean) AddAttribute(String, String, Boolean) AddAttribute(String, String, Boolean)

Adds the specified markup attribute and value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method, with optional encoding.

(Inherited from HtmlTextWriter)
AddAttribute(String, String, HtmlTextWriterAttribute) AddAttribute(String, String, HtmlTextWriterAttribute) AddAttribute(String, String, HtmlTextWriterAttribute) AddAttribute(String, String, HtmlTextWriterAttribute)

Adds the specified markup attribute and value, along with an HtmlTextWriterAttribute enumeration value, to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method.

(Inherited from HtmlTextWriter)
AddRecognizedAttribute(String, String) AddRecognizedAttribute(String, String) AddRecognizedAttribute(String, String) AddRecognizedAttribute(String, String)

Adds an attribute to an XHTML element. The collection of element-specific attributes for the XhtmlTextWriter object is referenced by the ElementSpecificAttributes property.

AddStyleAttribute(HtmlTextWriterStyle, String) AddStyleAttribute(HtmlTextWriterStyle, String) AddStyleAttribute(HtmlTextWriterStyle, String) AddStyleAttribute(HtmlTextWriterStyle, String)

Adds the markup style attribute associated with the specified HtmlTextWriterStyle value and the attribute value to the opening markup tag created by a subsequent call to the RenderBeginTag method.

(Inherited from HtmlTextWriter)
AddStyleAttribute(String, String) AddStyleAttribute(String, String) AddStyleAttribute(String, String) AddStyleAttribute(String, String)

Adds the specified markup style attribute and the attribute value to the opening markup tag created by a subsequent call to the RenderBeginTag method.

(Inherited from HtmlTextWriter)
AddStyleAttribute(String, String, HtmlTextWriterStyle) AddStyleAttribute(String, String, HtmlTextWriterStyle) AddStyleAttribute(String, String, HtmlTextWriterStyle) AddStyleAttribute(String, String, HtmlTextWriterStyle)

Adds the specified markup style attribute and the attribute value, along with an HtmlTextWriterStyle enumeration value, to the opening markup tag created by a subsequent call to the RenderBeginTag method.

(Inherited from HtmlTextWriter)
BeginRender() BeginRender() BeginRender() BeginRender()

Notifies an HtmlTextWriter object, or an object of a derived class, that a control is about to be rendered.

(Inherited from HtmlTextWriter)
Close() Close() Close() Close()

Closes the HtmlTextWriter object and releases any system resources associated with it.

(Inherited from HtmlTextWriter)
CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject)
Dispose() Dispose() Dispose() Dispose()

Releases all resources used by the TextWriter object.

(Inherited from TextWriter)
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources.

(Inherited from TextWriter)
DisposeAsync() DisposeAsync() DisposeAsync() DisposeAsync() Inherited from TextWriter
EncodeAttributeValue(HtmlTextWriterAttribute, String) EncodeAttributeValue(HtmlTextWriterAttribute, String) EncodeAttributeValue(HtmlTextWriterAttribute, String) EncodeAttributeValue(HtmlTextWriterAttribute, String)

Encodes the value of the specified markup attribute based on the requirements of the HttpRequest object of the current context.

(Inherited from HtmlTextWriter)
EncodeAttributeValue(String, Boolean) EncodeAttributeValue(String, Boolean) EncodeAttributeValue(String, Boolean) EncodeAttributeValue(String, Boolean)

Encodes the value of the specified markup attribute based on the requirements of the HttpRequest object of the current context.

(Inherited from HtmlTextWriter)
EncodeUrl(String) EncodeUrl(String) EncodeUrl(String) EncodeUrl(String)

Performs minimal URL encoding by converting spaces in the specified URL to the string "%20".

(Inherited from HtmlTextWriter)
EndRender() EndRender() EndRender() EndRender()

Notifies an HtmlTextWriter object, or an object of a derived class, that a control has finished rendering. You can use this method to close any markup elements opened in the BeginRender() method.

(Inherited from HtmlTextWriter)
EnterStyle(Style) EnterStyle(Style) EnterStyle(Style) EnterStyle(Style)

Writes the opening tag of a <span> element that contains attributes that implement the layout and character formatting of the specified style.

(Inherited from HtmlTextWriter)
EnterStyle(Style, HtmlTextWriterTag) EnterStyle(Style, HtmlTextWriterTag) EnterStyle(Style, HtmlTextWriterTag) EnterStyle(Style, HtmlTextWriterTag)

Writes the opening tag of a markup element that contains attributes that implement the layout and character formatting of the specified style.

(Inherited from HtmlTextWriter)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
ExitStyle(Style) ExitStyle(Style) ExitStyle(Style) ExitStyle(Style)

Writes the closing tag of a <span> element to end the specified layout and character formatting.

(Inherited from HtmlTextWriter)
ExitStyle(Style, HtmlTextWriterTag) ExitStyle(Style, HtmlTextWriterTag) ExitStyle(Style, HtmlTextWriterTag) ExitStyle(Style, HtmlTextWriterTag)

Writes the closing tag of the specified markup element to end the specified layout and character formatting.

(Inherited from HtmlTextWriter)
FilterAttributes() FilterAttributes() FilterAttributes() FilterAttributes()

Removes all the markup and style attributes on all properties of the page or Web server control.

(Inherited from HtmlTextWriter)
Flush() Flush() Flush() Flush()

Clears all buffers for the current HtmlTextWriter object and causes any buffered data to be written to the output stream.

(Inherited from HtmlTextWriter)
FlushAsync() FlushAsync() FlushAsync() FlushAsync()

Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

(Inherited from TextWriter)
GetAttributeKey(String) GetAttributeKey(String) GetAttributeKey(String) GetAttributeKey(String)

Obtains the corresponding HtmlTextWriterAttribute enumeration value for the specified attribute.

(Inherited from HtmlTextWriter)
GetAttributeName(HtmlTextWriterAttribute) GetAttributeName(HtmlTextWriterAttribute) GetAttributeName(HtmlTextWriterAttribute) GetAttributeName(HtmlTextWriterAttribute)

Obtains the name of the markup attribute associated with the specified HtmlTextWriterAttribute value.

(Inherited from HtmlTextWriter)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetStyleKey(String) GetStyleKey(String) GetStyleKey(String) GetStyleKey(String)

Obtains the HtmlTextWriterStyle enumeration value for the specified style.

(Inherited from HtmlTextWriter)
GetStyleName(HtmlTextWriterStyle) GetStyleName(HtmlTextWriterStyle) GetStyleName(HtmlTextWriterStyle) GetStyleName(HtmlTextWriterStyle)

Obtains the markup style attribute name associated with the specified HtmlTextWriterStyle enumeration value.

(Inherited from HtmlTextWriter)
GetTagKey(String) GetTagKey(String) GetTagKey(String) GetTagKey(String)

Obtains the HtmlTextWriterTag enumeration value associated with the specified markup element.

(Inherited from HtmlTextWriter)
GetTagName(HtmlTextWriterTag) GetTagName(HtmlTextWriterTag) GetTagName(HtmlTextWriterTag) GetTagName(HtmlTextWriterTag)

Obtains the markup element associated with the specified HtmlTextWriterTag enumeration value.

(Inherited from HtmlTextWriter)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
IsAttributeDefined(HtmlTextWriterAttribute) IsAttributeDefined(HtmlTextWriterAttribute) IsAttributeDefined(HtmlTextWriterAttribute) IsAttributeDefined(HtmlTextWriterAttribute)

Determines whether the specified markup attribute and its value are rendered during the next call to the RenderBeginTag method.

(Inherited from HtmlTextWriter)
IsAttributeDefined(HtmlTextWriterAttribute, String) IsAttributeDefined(HtmlTextWriterAttribute, String) IsAttributeDefined(HtmlTextWriterAttribute, String) IsAttributeDefined(HtmlTextWriterAttribute, String)

Determines whether the specified markup attribute and its value are rendered during the next call to the RenderBeginTag method.

(Inherited from HtmlTextWriter)
IsStyleAttributeDefined(HtmlTextWriterStyle) IsStyleAttributeDefined(HtmlTextWriterStyle) IsStyleAttributeDefined(HtmlTextWriterStyle) IsStyleAttributeDefined(HtmlTextWriterStyle)

Determines whether the specified markup style attribute is rendered during the next call to the RenderBeginTag method.

(Inherited from HtmlTextWriter)
IsStyleAttributeDefined(HtmlTextWriterStyle, String) IsStyleAttributeDefined(HtmlTextWriterStyle, String) IsStyleAttributeDefined(HtmlTextWriterStyle, String) IsStyleAttributeDefined(HtmlTextWriterStyle, String)

Determines whether the specified markup style attribute and its value are rendered during the next call to the RenderBeginTag method.

(Inherited from HtmlTextWriter)
IsValidFormAttribute(String) IsValidFormAttribute(String) IsValidFormAttribute(String) IsValidFormAttribute(String)

Checks an XHTML attribute to ensure that it can be rendered in the opening tag of a <form> element.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
OnAttributeRender(String, String, HtmlTextWriterAttribute) OnAttributeRender(String, String, HtmlTextWriterAttribute) OnAttributeRender(String, String, HtmlTextWriterAttribute) OnAttributeRender(String, String, HtmlTextWriterAttribute)

Determines whether the specified XHTML attribute and its value can be rendered to the current markup element.

OnStyleAttributeRender(String, String, HtmlTextWriterStyle) OnStyleAttributeRender(String, String, HtmlTextWriterStyle) OnStyleAttributeRender(String, String, HtmlTextWriterStyle) OnStyleAttributeRender(String, String, HtmlTextWriterStyle)

Determines whether the specified XHTML style attribute and its value can be rendered to the current markup element.

OnTagRender(String, HtmlTextWriterTag) OnTagRender(String, HtmlTextWriterTag) OnTagRender(String, HtmlTextWriterTag) OnTagRender(String, HtmlTextWriterTag)

Determines whether the specified markup element will be rendered to the requesting page.

(Inherited from HtmlTextWriter)
OutputTabs() OutputTabs() OutputTabs() OutputTabs()

Writes a series of tab strings that represent the indentation level for a line of markup characters.

(Inherited from HtmlTextWriter)
PopEndTag() PopEndTag() PopEndTag() PopEndTag()

Removes the most recently saved markup element from the list of rendered elements.

(Inherited from HtmlTextWriter)
PushEndTag(String) PushEndTag(String) PushEndTag(String) PushEndTag(String)

Saves the specified markup element for later use when generating the end tag for a markup element.

(Inherited from HtmlTextWriter)
RemoveRecognizedAttribute(String, String) RemoveRecognizedAttribute(String, String) RemoveRecognizedAttribute(String, String) RemoveRecognizedAttribute(String, String)

Removes an attribute from the ElementSpecificAttributes collection of an element.

RenderAfterContent() RenderAfterContent() RenderAfterContent() RenderAfterContent()

Writes any text or spacing that occurs after the content and before the closing tag of the markup element to the markup output stream.

(Inherited from HtmlTextWriter)
RenderAfterTag() RenderAfterTag() RenderAfterTag() RenderAfterTag()

Writes any spacing or text that occurs after the closing tag for a markup element.

(Inherited from HtmlTextWriter)
RenderBeforeContent() RenderBeforeContent() RenderBeforeContent() RenderBeforeContent()

Writes any text or spacing before the content and after the opening tag of a markup element.

(Inherited from HtmlTextWriter)
RenderBeforeTag() RenderBeforeTag() RenderBeforeTag() RenderBeforeTag()

Writes any text or spacing that occurs before the opening tag of a markup element.

(Inherited from HtmlTextWriter)
RenderBeginTag(HtmlTextWriterTag) RenderBeginTag(HtmlTextWriterTag) RenderBeginTag(HtmlTextWriterTag) RenderBeginTag(HtmlTextWriterTag)

Writes the opening tag of the markup element associated with the specified HtmlTextWriterTag enumeration value to the output stream.

(Inherited from HtmlTextWriter)
RenderBeginTag(String) RenderBeginTag(String) RenderBeginTag(String) RenderBeginTag(String)

Writes the opening tag of the specified markup element to the output stream.

(Inherited from HtmlTextWriter)
RenderEndTag() RenderEndTag() RenderEndTag() RenderEndTag()

Writes the end tag of a markup element to the output stream.

(Inherited from HtmlTextWriter)
SetDocType(XhtmlMobileDocType) SetDocType(XhtmlMobileDocType) SetDocType(XhtmlMobileDocType) SetDocType(XhtmlMobileDocType)

Specifies the XHTML document type for the text writer to render to the page or control.

ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
Write(Boolean) Write(Boolean) Write(Boolean) Write(Boolean)

Writes the text representation of a Boolean value to the output stream, along with any pending tab spacing.

(Inherited from HtmlTextWriter)
Write(Char) Write(Char) Write(Char) Write(Char)

Writes the text representation of a Unicode character to the output stream, along with any pending tab spacing.

(Inherited from HtmlTextWriter)
Write(Char[]) Write(Char[]) Write(Char[]) Write(Char[])

Writes the text representation of an array of Unicode characters to the output stream, along with any pending tab spacing.

(Inherited from HtmlTextWriter)
Write(Char[], Int32, Int32) Write(Char[], Int32, Int32) Write(Char[], Int32, Int32) Write(Char[], Int32, Int32)

Writes the text representation of a subarray of Unicode characters to the output stream, along with any pending tab spacing.

(Inherited from HtmlTextWriter)
Write(Decimal) Write(Decimal) Write(Decimal) Write(Decimal)

Writes the text representation of a decimal value to the text string or stream.

(Inherited from TextWriter)
Write(Double) Write(Double) Write(Double) Write(Double)

Writes the text representation of a double-precision floating-point number to the output stream, along with any pending tab spacing.

(Inherited from HtmlTextWriter)
Write(Int32) Write(Int32) Write(Int32) Write(Int32)

Writes the text representation of a 32-byte signed integer to the output stream, along with any pending tab spacing.

(Inherited from HtmlTextWriter)
Write(Int64) Write(Int64) Write(Int64) Write(Int64)

Writes the text representation of a 64-byte signed integer to the output stream, along with any pending tab spacing.

(Inherited from HtmlTextWriter)
Write(Object) Write(Object) Write(Object) Write(Object)

Writes the text representation of an object to the output stream, along with any pending tab spacing.

(Inherited from HtmlTextWriter)
Write(ReadOnlySpan<Char>) Write(ReadOnlySpan<Char>) Write(ReadOnlySpan<Char>) Write(ReadOnlySpan<Char>) Inherited from TextWriter
Write(Single) Write(Single) Write(Single) Write(Single)

Writes the text representation of a single-precision floating-point number to the output stream, along with any pending tab spacing.

(Inherited from HtmlTextWriter)
Write(String) Write(String) Write(String) Write(String)

Writes the specified string to the output stream, along with any pending tab spacing.

(Inherited from HtmlTextWriter)
Write(String, Object) Write(String, Object) Write(String, Object) Write(String, Object)

Writes a tab string and a formatted string to the output stream, using the same semantics as the Format(String, Object) method, along with any pending tab spacing.

(Inherited from HtmlTextWriter)
Write(String, Object, Object) Write(String, Object, Object) Write(String, Object, Object) Write(String, Object, Object)

Writes a formatted string that contains the text representation of two objects to the output stream, along with any pending tab spacing. This method uses the same semantics as the Format(String, Object, Object) method.

(Inherited from HtmlTextWriter)
Write(String, Object, Object, Object) Write(String, Object, Object, Object) Write(String, Object, Object, Object) Write(String, Object, Object, Object)

Writes a formatted string to the text string or stream, using the same semantics as the Format(String, Object, Object, Object) method.

(Inherited from TextWriter)
Write(String, Object[]) Write(String, Object[]) Write(String, Object[]) Write(String, Object[])

Writes a formatted string that contains the text representation of an object array to the output stream, along with any pending tab spacing. This method uses the same semantics as the Format(String, Object[]) method.

(Inherited from HtmlTextWriter)
Write(StringBuilder) Write(StringBuilder) Write(StringBuilder) Write(StringBuilder) Inherited from TextWriter
Write(UInt32) Write(UInt32) Write(UInt32) Write(UInt32)

Writes the text representation of a 4-byte unsigned integer to the text string or stream.

(Inherited from TextWriter)
Write(UInt64) Write(UInt64) Write(UInt64) Write(UInt64)

Writes the text representation of an 8-byte unsigned integer to the text string or stream.

(Inherited from TextWriter)
WriteAsync(Char) WriteAsync(Char) WriteAsync(Char) WriteAsync(Char)

Writes a character to the text string or stream asynchronously.

(Inherited from TextWriter)
WriteAsync(Char[]) WriteAsync(Char[]) WriteAsync(Char[]) WriteAsync(Char[])

Writes a character array to the text string or stream asynchronously.

(Inherited from TextWriter)
WriteAsync(Char[], Int32, Int32) WriteAsync(Char[], Int32, Int32) WriteAsync(Char[], Int32, Int32) WriteAsync(Char[], Int32, Int32)

Writes a subarray of characters to the text string or stream asynchronously.

(Inherited from TextWriter)
WriteAsync(ReadOnlyMemory<Char>, CancellationToken) WriteAsync(ReadOnlyMemory<Char>, CancellationToken) WriteAsync(ReadOnlyMemory<Char>, CancellationToken) WriteAsync(ReadOnlyMemory<Char>, CancellationToken) Inherited from TextWriter
WriteAsync(String) WriteAsync(String) WriteAsync(String) WriteAsync(String)

Writes a string to the text string or stream asynchronously.

(Inherited from TextWriter)
WriteAsync(StringBuilder, CancellationToken) WriteAsync(StringBuilder, CancellationToken) WriteAsync(StringBuilder, CancellationToken) WriteAsync(StringBuilder, CancellationToken) Inherited from TextWriter
WriteAttribute(String, String) WriteAttribute(String, String) WriteAttribute(String, String) WriteAttribute(String, String)

Writes the specified markup attribute and value to the output stream.

(Inherited from HtmlTextWriter)
WriteAttribute(String, String, Boolean) WriteAttribute(String, String, Boolean) WriteAttribute(String, String, Boolean) WriteAttribute(String, String, Boolean)

Writes the specified markup attribute and value to the output stream, and, if specified, writes the value encoded.

(Inherited from HtmlTextWriter)
WriteBeginTag(String) WriteBeginTag(String) WriteBeginTag(String) WriteBeginTag(String)

Writes any tab spacing and the opening tag of the specified markup element to the output stream.

(Inherited from HtmlTextWriter)
WriteBreak() WriteBreak() WriteBreak() WriteBreak()

Writes a <br/> element to the XHTML output stream.

WriteEncodedText(String) WriteEncodedText(String) WriteEncodedText(String) WriteEncodedText(String)

Encodes the specified text for the requesting device, and then writes it to the output stream.

(Inherited from HtmlTextWriter)
WriteEncodedUrl(String) WriteEncodedUrl(String) WriteEncodedUrl(String) WriteEncodedUrl(String)

Encodes the specified URL, and then writes it to the output stream. The URL might include parameters.

(Inherited from HtmlTextWriter)
WriteEncodedUrlParameter(String) WriteEncodedUrlParameter(String) WriteEncodedUrlParameter(String) WriteEncodedUrlParameter(String)

Encodes the specified URL parameter for the requesting device, and then writes it to the output stream.

(Inherited from HtmlTextWriter)
WriteEndTag(String) WriteEndTag(String) WriteEndTag(String) WriteEndTag(String)

Writes any tab spacing and the closing tag of the specified markup element.

(Inherited from HtmlTextWriter)
WriteFullBeginTag(String) WriteFullBeginTag(String) WriteFullBeginTag(String) WriteFullBeginTag(String)

Writes any tab spacing and the opening tag of the specified markup element to the output stream.

(Inherited from HtmlTextWriter)
WriteLine() WriteLine() WriteLine() WriteLine()

Writes a line terminator string to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(Boolean) WriteLine(Boolean) WriteLine(Boolean) WriteLine(Boolean)

Writes any pending tab spacing and the text representation of a Boolean value, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(Char) WriteLine(Char) WriteLine(Char) WriteLine(Char)

Writes any pending tab spacing and a Unicode character, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(Char[]) WriteLine(Char[]) WriteLine(Char[]) WriteLine(Char[])

Writes any pending tab spacing and an array of Unicode characters, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(Char[], Int32, Int32) WriteLine(Char[], Int32, Int32) WriteLine(Char[], Int32, Int32) WriteLine(Char[], Int32, Int32)

Writes any pending tab spacing and a subarray of Unicode characters, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(Decimal) WriteLine(Decimal) WriteLine(Decimal) WriteLine(Decimal)

Writes the text representation of a decimal value followed by a line terminator to the text string or stream.

(Inherited from TextWriter)
WriteLine(Double) WriteLine(Double) WriteLine(Double) WriteLine(Double)

Writes any pending tab spacing and the text representation of a double-precision floating-point number, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(Int32) WriteLine(Int32) WriteLine(Int32) WriteLine(Int32)

Writes any pending tab spacing and the text representation of a 32-byte signed integer, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(Int64) WriteLine(Int64) WriteLine(Int64) WriteLine(Int64)

Writes any pending tab spacing and the text representation of a 64-byte signed integer, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(Object) WriteLine(Object) WriteLine(Object) WriteLine(Object)

Writes any pending tab spacing and the text representation of an object, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(ReadOnlySpan<Char>) WriteLine(ReadOnlySpan<Char>) WriteLine(ReadOnlySpan<Char>) WriteLine(ReadOnlySpan<Char>) Inherited from TextWriter
WriteLine(Single) WriteLine(Single) WriteLine(Single) WriteLine(Single)

Writes any pending tab spacing and the text representation of a single-precision floating-point number, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(String) WriteLine(String) WriteLine(String) WriteLine(String)

Writes any pending tab spacing and a text string, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(String, Object) WriteLine(String, Object) WriteLine(String, Object) WriteLine(String, Object)

Writes any pending tab spacing and a formatted string containing the text representation of an object, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(String, Object, Object) WriteLine(String, Object, Object) WriteLine(String, Object, Object) WriteLine(String, Object, Object)

Writes any pending tab spacing and a formatted string that contains the text representation of two objects, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(String, Object, Object, Object) WriteLine(String, Object, Object, Object) WriteLine(String, Object, Object, Object) WriteLine(String, Object, Object, Object)

Writes out a formatted string and a new line, using the same semantics as Format(String, Object).

(Inherited from TextWriter)
WriteLine(String, Object[]) WriteLine(String, Object[]) WriteLine(String, Object[]) WriteLine(String, Object[])

Writes any pending tab spacing and a formatted string that contains the text representation of an object array, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(StringBuilder) WriteLine(StringBuilder) WriteLine(StringBuilder) WriteLine(StringBuilder) Inherited from TextWriter
WriteLine(UInt32) WriteLine(UInt32) WriteLine(UInt32) WriteLine(UInt32)

Writes any pending tab spacing and the text representation of a 4-byte unsigned integer, followed by a line terminator string, to the output stream.

(Inherited from HtmlTextWriter)
WriteLine(UInt64) WriteLine(UInt64) WriteLine(UInt64) WriteLine(UInt64)

Writes the text representation of an 8-byte unsigned integer followed by a line terminator to the text string or stream.

(Inherited from TextWriter)
WriteLineAsync() WriteLineAsync() WriteLineAsync() WriteLineAsync()

Writes a line terminator asynchronously to the text string or stream.

(Inherited from TextWriter)
WriteLineAsync(Char) WriteLineAsync(Char) WriteLineAsync(Char) WriteLineAsync(Char)

Writes a character followed by a line terminator asynchronously to the text string or stream.

(Inherited from TextWriter)
WriteLineAsync(Char[]) WriteLineAsync(Char[]) WriteLineAsync(Char[]) WriteLineAsync(Char[])

Writes an array of characters followed by a line terminator asynchronously to the text string or stream.

(Inherited from TextWriter)
WriteLineAsync(Char[], Int32, Int32) WriteLineAsync(Char[], Int32, Int32) WriteLineAsync(Char[], Int32, Int32) WriteLineAsync(Char[], Int32, Int32)

Writes a subarray of characters followed by a line terminator asynchronously to the text string or stream.

(Inherited from TextWriter)
WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken) WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken) WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken) WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken) Inherited from TextWriter
WriteLineAsync(String) WriteLineAsync(String) WriteLineAsync(String) WriteLineAsync(String)

Writes a string followed by a line terminator asynchronously to the text string or stream.

(Inherited from TextWriter)
WriteLineAsync(StringBuilder, CancellationToken) WriteLineAsync(StringBuilder, CancellationToken) WriteLineAsync(StringBuilder, CancellationToken) WriteLineAsync(StringBuilder, CancellationToken) Inherited from TextWriter
WriteLineNoTabs(String) WriteLineNoTabs(String) WriteLineNoTabs(String) WriteLineNoTabs(String)

Writes a string, followed by a line terminator string, to the output stream. This method ignores any specified tab spacing.

(Inherited from HtmlTextWriter)
WriteStyleAttribute(String, String) WriteStyleAttribute(String, String) WriteStyleAttribute(String, String) WriteStyleAttribute(String, String)

Writes the specified style attribute to the output stream.

(Inherited from HtmlTextWriter)
WriteStyleAttribute(String, String, Boolean) WriteStyleAttribute(String, String, Boolean) WriteStyleAttribute(String, String, Boolean) WriteStyleAttribute(String, String, Boolean)

Writes the specified style attribute and value to the output stream, and encodes the value, if specified.

(Inherited from HtmlTextWriter)
WriteUrlEncodedString(String, Boolean) WriteUrlEncodedString(String, Boolean) WriteUrlEncodedString(String, Boolean) WriteUrlEncodedString(String, Boolean)

Writes the specified string, encoding it according to URL requirements.

(Inherited from HtmlTextWriter)

Fields

CoreNewLine CoreNewLine CoreNewLine CoreNewLine

Stores the newline characters used for this TextWriter.

(Inherited from TextWriter)
DefaultTabString DefaultTabString DefaultTabString DefaultTabString

Represents a single tab character.

(Inherited from HtmlTextWriter)
DoubleQuoteChar DoubleQuoteChar DoubleQuoteChar DoubleQuoteChar

Represents the quotation mark (") character.

(Inherited from HtmlTextWriter)
EndTagLeftChars EndTagLeftChars EndTagLeftChars EndTagLeftChars

Represents the left angle bracket and slash mark (</) of the closing tag of a markup element.

(Inherited from HtmlTextWriter)
EqualsChar EqualsChar EqualsChar EqualsChar

Represents the equal sign (=).

(Inherited from HtmlTextWriter)
EqualsDoubleQuoteString EqualsDoubleQuoteString EqualsDoubleQuoteString EqualsDoubleQuoteString

Represents an equal sign (=) and a double quotation mark (") together in a string (=").

(Inherited from HtmlTextWriter)
SelfClosingChars SelfClosingChars SelfClosingChars SelfClosingChars

Represents a space and the self-closing slash mark (/) of a markup tag.

(Inherited from HtmlTextWriter)
SelfClosingTagEnd SelfClosingTagEnd SelfClosingTagEnd SelfClosingTagEnd

Represents the closing slash mark and right angle bracket (/>) of a self-closing markup element.

(Inherited from HtmlTextWriter)
SemicolonChar SemicolonChar SemicolonChar SemicolonChar

Represents the semicolon (;).

(Inherited from HtmlTextWriter)
SingleQuoteChar SingleQuoteChar SingleQuoteChar SingleQuoteChar

Represents an apostrophe (').

(Inherited from HtmlTextWriter)
SlashChar SlashChar SlashChar SlashChar

Represents the slash mark (/).

(Inherited from HtmlTextWriter)
SpaceChar SpaceChar SpaceChar SpaceChar

Represents a space ( ) character.

(Inherited from HtmlTextWriter)
StyleEqualsChar StyleEqualsChar StyleEqualsChar StyleEqualsChar

Represents the style equals (:) character used to set style attributes equal to values.

(Inherited from HtmlTextWriter)
TagLeftChar TagLeftChar TagLeftChar TagLeftChar

Represents the opening angle bracket (<) of a markup tag.

(Inherited from HtmlTextWriter)
TagRightChar TagRightChar TagRightChar TagRightChar

Represents the closing angle bracket (>) of a markup tag.

(Inherited from HtmlTextWriter)

Explicit Interface Implementations

IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose()

For a description of this member, see Dispose().

(Inherited from TextWriter)

Applies to

See also