This documentation is archived and is not being maintained.

HtmlTextWriter.NewLine Property

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

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

public override string NewLine { get; set; }

Property Value

Type: System.String
The line terminator string used by the current HtmlTextWriter.

The default line terminator string is a carriage return, followed by a line feed ("\r\n").

The line terminator string is written to the output stream whenever one of the WriteLine methods is called. If the NewLine property is set to null, the default new line character is used.

The following code example shows how to use a custom class, derived from the HtmlTextWriter class, that overrides the FilterAttributes method. When called, the FilterAttributes override checks whether the text writer renders any <label> or <a> elements. If so, the FilterAttributes method determines whether a style attribute is defined for the label. If no style is defined, the FilterAttributes method sets the default value for the style:color attribute to blue. The FilterAttributes method then uses the NewLine property to insert a line break in the markup tag and writes any other defined attributes.

// Override the FilterAttributes method to check whether  
// <label> and <anchor> elements contain specific attributes.       
protected override void FilterAttributes()
    // If the <label> element is rendered and a style 
    // attribute is not defined, add a style attribute  
    // and set its value to blue. 
    if (TagKey == HtmlTextWriterTag.Label)
        if (!IsAttributeDefined(HtmlTextWriterAttribute.Style))
            AddAttribute("style", EncodeAttributeValue("color:blue", true));
            Indent = 3;

    // If an <anchor> element is rendered and an href 
    // attribute has not been defined, call the AddAttribute 
    // method to add an href attribute 
    // and set it to 
    // Use the EncodeUrl method to convert any spaces to %20. 
    if (TagKey == HtmlTextWriterTag.A)
        if (!IsAttributeDefined(HtmlTextWriterAttribute.Href))
            AddAttribute("href", EncodeUrl(""));
    // Call the FilterAttributes method of the base class. 

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0