ASPxDashboard.ClientInstanceName Property

Gets or sets the ASPxDashboard‘s client programmatic identifier.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v24.1.Web.WebForms.dll

NuGet Package: DevExpress.Web.Dashboard

Declaration

C#

[DefaultValue("")]
public string ClientInstanceName { get; set; }

VB.NET

<DefaultValue("")>
Public Property ClientInstanceName As String

Property Value

Type	Default	Description
String	String.Empty	A String that specifies the ASPxDashboard‘s client identifier.

Remarks

Use the ClientInstanceName property to specify a unique client-side identifier for a ASPxDashboard control. The ClientInstanceName property’s value can be used on the client side to programmatically access the client object rendered for the Designer in client-side script. This property is particularly important in referencing the Web Dashboard when it is contained within a naming container (for instance, within an ASPxPageControl‘s page or an ASPxPopupControl‘s window).

If the ClientInstanceName property is not specified, a Web Dashboard’s client identifier is generated automatically and equals the value of the control’s ID property. Note that in this case, client-side programmatic access to the Web Dashboard by its ID is not allowed when the control is contained within a naming container.

The Web Dashboard’s client instance is represented by the ASPxClientDashboard class.