ASPxHtmlEditor.CustomJSProperties Event

Enables you to supply any server data that can then be parsed on the client.

Namespace: DevExpress.Web.ASPxHtmlEditor

Assembly: DevExpress.Web.ASPxHtmlEditor.v19.2.dll


public event CustomJSPropertiesEventHandler CustomJSProperties
Public Event CustomJSProperties As CustomJSPropertiesEventHandler

Event Data

The CustomJSProperties event handler receives an argument of the CustomJSPropertiesEventArgs type. The following properties provide information specific to this event.

Property Description
Properties Gets a collection of temporary client properties.


In some instances, it is necessary to obtain server information on the client. The CustomJSProperties event enables you to declare temporary client properties. Once declared, a property can be accessed on the client.

To add new properties, use the event parameter's CustomJSPropertiesEventArgs.Properties property, which represents a collection of property names and their values. The only requirement is that property names must begin with the 'cp' prefix, to avoid rewriting the ASPxHtmlEditor's base properties.


Typically, using a specifically introduced ASPxHtmlEditor.JSProperties property might be more convenient and efficient than handling the CustomJSProperties event, which is mostly declared for backward compatibility.


How to Access Server Data on the Client Side


This example demonstrates how to obtain server data from the client. A temporary client property - cpHtmlContent, is declared within the ASPxHtmlEditor.CustomJSProperties event handler. This property holds the html content of the ASPxHtmlEditor, and can be accessed on the client.

protected void ASPxHtmlEditor1_CustomJSProperties(object sender, 
DevExpress.Web.CustomJSPropertiesEventArgs e) {
    e.Properties["cpHtmlContent"] = ASPxHtmlEditor1.Html;
See Also