ContextButtonBase.AllowHtmlText Property

Gets or sets whether the current button's caption is formatted using HTML tags.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v20.2.dll


public DefaultBoolean AllowHtmlText { get; set; }
Public Property AllowHtmlText As DefaultBoolean

Property Value

Type Default Description


A DefaultBoolean enumeration value that specifies whether the current button's caption is formatted using HTML tags.

Available values:

Name Description

Corresponds to a Boolean value of true.


Corresponds to a Boolean value of false.


The value is determined by the current object's parent object setting (e.g., a control setting).


The button caption specified by the ContextButtonBase.Caption property can be formatted using HTML tags. Set the AllowHtmlText property to True to enable this feature. If this property is set to Default, the feature is controlled by the owner control. To specify the global setting, use the corresponding property, accessible using the ContextButtonOptions property of the owner control. The AllowHtmlText property overrides the global setting for the current button.

HTML formatting allows you to display hyperlinks in the button caption using the href tag. See the ContextButtonBase.HyperlinkClick event to learn how to handle a click on a hyperlink.

For detailed information on supported HTML tags, see the HTML Text Formatting topic.

See Also