ChtmlTextWriter Class
TOC
Collapse the table of content
Expand the table of content

ChtmlTextWriter Class

 

Writes a series of cHTML-specific characters and text to the output stream of an ASP.NET server control. The ChtmlTextWriter class provides formatting capabilities that ASP.NET server controls use when rendering cHTML content to clients.

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

System.Object
  System.MarshalByRefObject
    System.IO.TextWriter
      System.Web.UI.HtmlTextWriter
        System.Web.UI.Html32TextWriter
          System.Web.UI.ChtmlTextWriter

public class ChtmlTextWriter : Html32TextWriter

NameDescription
System_CAPS_pubmethodChtmlTextWriter(TextWriter)

Initializes a new instance of the ChtmlTextWriter class that uses the DefaultTabString constant to indent lines.

System_CAPS_pubmethodChtmlTextWriter(TextWriter, String)

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

NameDescription
System_CAPS_pubpropertyEncoding

Gets the encoding that the HtmlTextWriter object uses to write content to the page.(Inherited from HtmlTextWriter.)

System_CAPS_protpropertyFontStack

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection of font information for the HTML to render.(Inherited from Html32TextWriter.)

System_CAPS_pubpropertyFormatProvider

Gets an object that controls formatting.(Inherited from TextWriter.)

System_CAPS_protpropertyGlobalSuppressedAttributes

Gets a Hashtable object of globally suppressed attributes that cannot be rendered on cHTML elements.

System_CAPS_pubpropertyIndent

Gets or sets the number of tab positions to indent the beginning of each line of markup.(Inherited from HtmlTextWriter.)

System_CAPS_pubpropertyInnerWriter

Gets or sets the text writer that writes the inner content of the markup element.(Inherited from HtmlTextWriter.)

System_CAPS_pubpropertyNewLine

Gets or sets the line terminator string used by the HtmlTextWriter object.(Inherited from HtmlTextWriter.)

System_CAPS_protpropertyRecognizedAttributes

Gets a Hashtable object of recognized attributes that could be rendered on cHTML elements.

System_CAPS_pubpropertyShouldPerformDivTableSubstitution

Gets or sets a Boolean value indicating whether to replace a Table element with a Div element to reduce the time that it takes to render a block of HTML.(Inherited from Html32TextWriter.)

System_CAPS_pubpropertySupportsBold

Gets or sets a Boolean value indicating whether the requesting device supports bold HTML text. Use the SupportsBold property to conditionally render bold text to the Html32TextWriter output stream.(Inherited from Html32TextWriter.)

System_CAPS_pubpropertySupportsItalic

Gets or sets a Boolean value indicating whether the requesting device supports italic HTML text. Use the SupportsItalic property to conditionally render italicized text to the Html32TextWriter output stream.(Inherited from Html32TextWriter.)

System_CAPS_protpropertySuppressedAttributes

Gets a Hashtable object of user-specified suppressed attributes that are not rendered on cHTML elements.

System_CAPS_protpropertyTagKey

Gets or sets the HtmlTextWriterTag value for the specified markup element.(Inherited from HtmlTextWriter.)

System_CAPS_protpropertyTagName

Gets or sets the tag name of the markup element being rendered.(Inherited from HtmlTextWriter.)

NameDescription
System_CAPS_pubmethodAddAttribute(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.)

System_CAPS_pubmethodAddAttribute(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.)

System_CAPS_pubmethodAddAttribute(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.)

System_CAPS_pubmethodAddAttribute(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.)

System_CAPS_protmethodAddAttribute(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.)

System_CAPS_pubmethodAddRecognizedAttribute(String, String)

Adds an attribute to a cHTML element of the ChtmlTextWriter object.

System_CAPS_pubmethodAddStyleAttribute(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.)

System_CAPS_pubmethodAddStyleAttribute(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.)

System_CAPS_protmethodAddStyleAttribute(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.)

System_CAPS_pubmethodBeginRender()

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

System_CAPS_pubmethodClose()

Closes the HtmlTextWriter object and releases any system resources associated with it.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodCreateObjRef(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.)

System_CAPS_pubmethodDispose()

Releases all resources used by the TextWriter object.(Inherited from TextWriter.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the TextWriter and optionally releases the managed resources.(Inherited from TextWriter.)

System_CAPS_protmethodEncodeAttributeValue(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.)

System_CAPS_protmethodEncodeAttributeValue(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.)

System_CAPS_protmethodEncodeUrl(String)

Performs minimal URL encoding by converting spaces in the specified URL to the string "%20".(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodEndRender()

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.)

System_CAPS_pubmethodEnterStyle(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.)

System_CAPS_pubmethodEnterStyle(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.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodExitStyle(Style)

Writes the closing tag of a <span> element to end the specified layout and character formatting. (Inherited from HtmlTextWriter.)

System_CAPS_pubmethodExitStyle(Style, HtmlTextWriterTag)

Writes the closing tag of the specified markup element to end the specified layout and character formatting. (Inherited from HtmlTextWriter.)

System_CAPS_protmethodFilterAttributes()

Removes all the markup and style attributes on all properties of the page or Web server control.(Inherited from HtmlTextWriter.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFlush()

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

System_CAPS_pubmethodFlushAsync()

Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device. (Inherited from TextWriter.)

System_CAPS_protmethodGetAttributeKey(String)

Obtains the corresponding HtmlTextWriterAttribute enumeration value for the specified attribute.(Inherited from HtmlTextWriter.)

System_CAPS_protmethodGetAttributeName(HtmlTextWriterAttribute)

Obtains the name of the markup attribute associated with the specified HtmlTextWriterAttribute value.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodGetStyleKey(String)

Obtains the HtmlTextWriterStyle enumeration value for the specified style.(Inherited from HtmlTextWriter.)

System_CAPS_protmethodGetStyleName(HtmlTextWriterStyle)

Obtains the markup style attribute name associated with the specified HtmlTextWriterStyle enumeration value.(Inherited from HtmlTextWriter.)

System_CAPS_protmethodGetTagKey(String)

Obtains the HtmlTextWriterTag enumeration value associated with the specified markup element.(Inherited from HtmlTextWriter.)

System_CAPS_protmethodGetTagName(HtmlTextWriterTag)

Returns the HTML element that is associated with the specified HtmlTextWriterTag enumeration value.(Inherited from Html32TextWriter.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodIsAttributeDefined(HtmlTextWriterAttribute)

Determines whether the specified markup attribute and its value are rendered during the next call to the RenderBeginTag method.(Inherited from HtmlTextWriter.)

System_CAPS_protmethodIsAttributeDefined(HtmlTextWriterAttribute, String)

Determines whether the specified markup attribute and its value are rendered during the next call to the RenderBeginTag method.(Inherited from HtmlTextWriter.)

System_CAPS_protmethodIsStyleAttributeDefined(HtmlTextWriterStyle)

Determines whether the specified markup style attribute is rendered during the next call to the RenderBeginTag method.(Inherited from HtmlTextWriter.)

System_CAPS_protmethodIsStyleAttributeDefined(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.)

System_CAPS_pubmethodIsValidFormAttribute(String)

Checks an attribute to ensure that it can be rendered in the opening tag of a <form> markup element. (Inherited from HtmlTextWriter.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodOnAttributeRender(String, String, HtmlTextWriterAttribute)

Determines whether the specified cHTML attribute and its value are rendered to the requesting page. You can override the OnAttributeRender method in classes that derive from the ChtmlTextWriter class to filter out attributes that you do not want to render on devices that support cHTML.(Overrides HtmlTextWriter.OnAttributeRender(String, String, HtmlTextWriterAttribute).)

System_CAPS_protmethodOnStyleAttributeRender(String, String, HtmlTextWriterStyle)

Determines whether the specified cHTML markup style attribute and its value can be rendered to the current markup element.(Overrides Html32TextWriter.OnStyleAttributeRender(String, String, HtmlTextWriterStyle).)

System_CAPS_protmethodOnTagRender(String, HtmlTextWriterTag)

Determines whether the specified cHTML markup element is rendered to the requesting page. (Overrides Html32TextWriter.OnTagRender(String, HtmlTextWriterTag).)

System_CAPS_protmethodOutputTabs()

Writes a series of tab strings that represent the indentation level for a line of markup characters.(Inherited from HtmlTextWriter.)

System_CAPS_protmethodPopEndTag()

Removes the most recently saved markup element from the list of rendered elements.(Inherited from HtmlTextWriter.)

System_CAPS_protmethodPushEndTag(String)

Saves the specified markup element for later use when generating the end tag for a markup element.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodRemoveRecognizedAttribute(String, String)

Removes an attribute of a cHTML element of the ChtmlTextWriter object.

System_CAPS_protmethodRenderAfterContent()

Writes any text or spacing that appears after the content of the HTML element.(Inherited from Html32TextWriter.)

System_CAPS_protmethodRenderAfterTag()

Writes any spacing or text that occurs after an HTML element's closing tag.(Inherited from Html32TextWriter.)

System_CAPS_protmethodRenderBeforeContent()

Writes any tab spacing or font information that appears before the content that is contained in an HTML element.(Inherited from Html32TextWriter.)

System_CAPS_protmethodRenderBeforeTag()

Writes any text or tab spacing that occurs before the opening tag of an HTML element to the HTML 3.2 output stream.(Inherited from Html32TextWriter.)

System_CAPS_pubmethodRenderBeginTag(HtmlTextWriterTag)

Writes the opening tag of the specified element to the HTML 3.2 output stream.(Inherited from Html32TextWriter.)

System_CAPS_pubmethodRenderBeginTag(String)

Writes the opening tag of the specified markup element to the output stream.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodRenderEndTag()

Writes the end tag of an HTML element to the Html32TextWriter output stream, along with any font information that is associated with the element.(Inherited from Html32TextWriter.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWrite(Boolean)

Writes the text representation of a Boolean value to the output stream, along with any pending tab spacing.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWrite(Char)

Writes the text representation of a Unicode character to the output stream, along with any pending tab spacing.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWrite(Char[])

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

System_CAPS_pubmethodWrite(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.)

System_CAPS_pubmethodWrite(Decimal)

Writes the text representation of a decimal value to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWrite(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.)

System_CAPS_pubmethodWrite(Int32)

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

System_CAPS_pubmethodWrite(Int64)

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

System_CAPS_pubmethodWrite(Object)

Writes the text representation of an object to the output stream, along with any pending tab spacing.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWrite(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.)

System_CAPS_pubmethodWrite(String)

Writes the specified string to the output stream, along with any pending tab spacing.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWrite(String, Object)

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

System_CAPS_pubmethodWrite(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 String.Format method.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWrite(String, Object, Object, Object)

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

System_CAPS_pubmethodWrite(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 String.Format method.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWrite(UInt32)

Writes the text representation of a 4-byte unsigned integer to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWrite(UInt64)

Writes the text representation of an 8-byte unsigned integer to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteAsync(Char)

Writes a character to the text string or stream asynchronously.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteAsync(Char[])

Writes a character array to the text string or stream asynchronously.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteAsync(Char[], Int32, Int32)

Writes a subarray of characters to the text string or stream asynchronously. (Inherited from TextWriter.)

System_CAPS_pubmethodWriteAsync(String)

Writes a string to the text string or stream asynchronously.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteAttribute(String, String)

Writes the specified markup attribute and value to the output stream.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWriteAttribute(String, String, Boolean)

Writes the specified markup attribute and value to the output stream, and, if specified, writes the value encoded.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWriteBeginTag(String)

Writes any tab spacing and the opening tag of the specified markup element to the output stream.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWriteBreak()

Writes a br element to the cHTML output stream.(Overrides HtmlTextWriter.WriteBreak().)

System_CAPS_pubmethodWriteEncodedText(String)

Encodes the specified text for the requesting device, and then writes it to the output stream. (Overrides HtmlTextWriter.WriteEncodedText(String).)

System_CAPS_pubmethodWriteEncodedUrl(String)

Encodes the specified URL, and then writes it to the output stream. The URL might include parameters.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWriteEncodedUrlParameter(String)

Encodes the specified URL parameter for the requesting device, and then writes it to the output stream.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWriteEndTag(String)

Writes any tab spacing and the closing tag of the specified markup element.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWriteFullBeginTag(String)

Writes any tab spacing and the opening tag of the specified markup element to the output stream.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWriteLine()

Writes a line terminator string to the output stream.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(Char)

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

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(Decimal)

Writes the text representation of a decimal value followed by a line terminator to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(String)

Writes any pending tab spacing and a text string, followed by a line terminator string, to the output stream.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(String, Object, Object, Object)

Writes out a formatted string and a new line, using the same semantics as Format.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLine(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.)

System_CAPS_pubmethodWriteLineAsync()

Writes a line terminator asynchronously to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLineAsync(Char)

Writes a character followed by a line terminator asynchronously to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLineAsync(Char[])

Writes an array of characters followed by a line terminator asynchronously to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLineAsync(Char[], Int32, Int32)

Writes a subarray of characters followed by a line terminator asynchronously to the text string or stream.(Inherited from TextWriter.)

System_CAPS_pubmethodWriteLineAsync(String)

Writes a string followed by a line terminator asynchronously to the text string or stream. (Inherited from TextWriter.)

System_CAPS_pubmethodWriteLineNoTabs(String)

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

System_CAPS_pubmethodWriteStyleAttribute(String, String)

Writes the specified style attribute to the output stream.(Inherited from HtmlTextWriter.)

System_CAPS_pubmethodWriteStyleAttribute(String, String, Boolean)

Writes the specified style attribute and value to the output stream, and encodes the value, if specified.(Inherited from HtmlTextWriter.)

System_CAPS_protmethodWriteUrlEncodedString(String, Boolean)

Writes the specified string, encoding it according to URL requirements.(Inherited from HtmlTextWriter.)

NameDescription
System_CAPS_protfieldCoreNewLine

Stores the newline characters used for this TextWriter.(Inherited from TextWriter.)

Compact HTML, or cHTML, is a subset of HTML 2.0, HTML 3.2, and HTML 4.0, and is designed to render on devices with limited memory and CPU power, along with small display screens, limited formatting capabilities, and a limited number of input options (such as a cell phone touch pad). Therefore, cHTML does not support the following:

  • JPEG images.

  • Tables.

  • Image maps.

  • Multiple character fonts and styles.

  • Background colors and images.

  • Frames.

  • Style sheets.

The ChtmlTextWriter class derives from the Html32TextWriter class and much of its functionality is provided by the Html32TextWriter and the base class for all markup text writers, which is the HtmlTextWriter class.

The following code example demonstrates how to create a class named CustomChtmlTextWriter that is derived from the ChtmlTextWriter class. It creates two constructors and overrides the OnAttributeRender method to prevent the bgcolor style attribute from being written to the output stream of the ChtmlTextWriter object. It also creates a class named ChtmlCustomPageAdapter that defines one method, CreateCustomChtmlTextWriter, which creates and returns an instance of the CustomChtmlTextWriter class. The CustomChtmlTextWriter then renders cHTML content for a page to devices with browsers that use cHTML markup.

// Create a class that derives from the
// ChtmlTextWriter class.
using System;
using System.IO;
using System.Web.UI;
using System.Web.UI.WebControls.Adapters;

namespace AspNet.Samples.CS
{
	public class CustomChtmlTextWriter : ChtmlTextWriter
	{
		// Create two constructors for the new
		// text writer.
		public CustomChtmlTextWriter(TextWriter writer) : base(writer, DefaultTabString)
		{
		}

		public CustomChtmlTextWriter(TextWriter writer, String tabString)
			: base(writer, tabString)
		{
		}

		// Override the OnAttributeRender method to
		// not render the bgcolor attribute, which is
		// not supported in CHTML.
		protected override bool OnAttributeRender(string name, string value, HtmlTextWriterAttribute key)
		{
			if (String.Equals("bgcolor", name))
			{
				return false;
			}

			// Call the ChtmlTextWriter version of the
			// the OnAttributeRender method.
			return base.OnAttributeRender(name, value, key);
		}
	}

	// Derive from the WebControlAdapter class,
	// provide a CreateCustomChtmlTextWriter
	// method to attach to the custom writer.
	public class ChtmlCustomPageAdapter : WebControlAdapter
	{
		protected internal ChtmlTextWriter CreateCustomChtmlTextWriter(
			TextWriter writer)
		{
			return new CustomChtmlTextWriter(writer);
		}
	}
}

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft