The requested page is not available for the requested platform. You are viewing the content for Default platform.

DashboardExtensionSettings.ClientInstanceName Property

Gets or sets the Web Dashboard 's client programmatic identifier.

Namespace: DevExpress.DashboardWeb.Mvc

Assembly: DevExpress.Dashboard.v19.1.Web.Mvc5.dll

Declaration

[Browsable(false)]
public string ClientInstanceName { get; set; }
<Browsable(False)>
Public Property ClientInstanceName As String

Property Value

Type Description
String

A String that specifies the Web Dashboard's client identifier.

Remarks

Use the ClientInstanceName property to specify a unique client-side identifier for the Web Dashboard. The ClientInstanceName property's value can be used on the client side to programmatically access the client object rendered for the Web Dashboard 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 Web Dashboard's ID property. Note that in this case, client-side programmatic access to the Web Dashboard by its ID is not allowed when the Web Dashboard is contained within a naming container.

See Also