Skip to main content

ASPxGaugeControl.CustomJSProperties Event

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

Namespace: DevExpress.Web.ASPxGauges

Assembly: DevExpress.Web.ASPxGauges.v24.2.dll

NuGet Package: DevExpress.Web.Visualization

#Declaration

public event CustomJSPropertiesEventHandler CustomJSProperties

#Event Data

The CustomJSProperties event's data class is CustomJSPropertiesEventArgs. The following properties provide information specific to this event:

Property Description
Properties Gets a collection of temporary client properties.

#Remarks

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 ASPxGaugeControl’s base properties.

Note

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

#Example

This example demonstrates how to obtain server data from the client. A temporary client property - cpDefaultValue - is declared within the ASPxGaugeControl.CustomJSProperties event handler. This property holds the ASPxGaugeControl’s default value. The ASPxGaugeControl.Value property specifies this value.

protected void ASPxGaugeControl1_CustomJSProperties(object sender,
           DevExpress.Web.CustomJSPropertiesEventArgs e) {
    e.Properties.Add("cpDefaultValue", ASPxGaugeControl1.Value);
}
See Also