ASPxGridViewCommandButtonSettings.EncodeHtml Property

Gets or sets a value that specifies whether a command button‘s display text keeps any of its values that are HTML as HTML, or instead, strips out the HTML markers.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.2.dll

Declaration

C#

[DefaultValue(false)]
public bool EncodeHtml { get; set; }

VB.NET

<DefaultValue(False)>
Public Property EncodeHtml As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true if the HTML code contained within the GridCommandButtonSettings.Text property value is not executed and is converted into the corresponding text for display purposes, false if the property value can contain pure HTML code.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to EncodeHtml
ASP.NET Controls and MVC Extensions	ASPxGridView	.SettingsCommandButton.EncodeHtml
	GridViewProperties	.SettingsCommandButton.EncodeHtml
	GridViewSettings	.SettingsCommandButton.EncodeHtml
	GridViewSettings<RowType>	.SettingsCommandButton.EncodeHtml
	MVCxGridView	.SettingsCommandButton.EncodeHtml
	MVCxGridViewProperties	.SettingsCommandButton.EncodeHtml
ASP.NET Bootstrap Controls	BootstrapGridView	.SettingsCommandButton.EncodeHtml

Remarks

If the EncodeHtml property is set to true, the GridCommandButtonSettings.Text property value that contains HTML code is parsed, so that any angle bracket (the characters < and >) of HTML tags is converted to specific symbols (&lt; and &gt;) when the grid renders its value to the page. This allows the HTML code to be displayed on the page as text.

If this property is set to false, the content of the GridCommandButtonSettings.Text property value that contains HTML tags is not specifically parsed, and is rendered as pure HTML markup. This allows the result of the HTML code to be displayed in grid command buttons.

Refer to the HTML Encoding topic for more information on DevExpress ASP.NET controls encoding.