This documentation is archived and is not being maintained.

BoundField.HtmlEncodeFormatString Property

Gets or sets a value that indicates whether text that is created by applying the DataFormatString property to the BoundField value should be HTML encoded when it is displayed.

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

public virtual bool HtmlEncodeFormatString { get; set; }

Property Value

Type: System.Boolean
true if the text should be HTML-encoded; otherwise, false. The default is true.

HTML-encoding values can help prevent cross-site scripting attacks and malicious content from being displayed. HTML encoding is also useful when you want to display HTML code in the browser, such as displaying the string "<br/>" instead of inserting a line break (<br/> element) in the page.


This property is new in ASP.NET 3.5. Setting this property to false restores the default behavior of the DataFormatString property in versions of ASP.NET earlier than 3.5. For more information, see the DataFormatString property.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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 SP1, 3.0 SP1, 2.0 SP1