WebChartControl.ClientInstanceName Property

Gets or sets the WebChartControl‘s client programmatic identifier.

Namespace: DevExpress.XtraCharts.Web

Assembly: DevExpress.XtraCharts.v24.1.Web.dll

NuGet Package: DevExpress.Web.Visualization

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 value that specifies the WebChartControl‘s client identifier.

Remarks

Use the ClientInstanceName property to specify a unique client-side identifier for a Web Chart control. The ClientInstanceName property’s value can be used on the client side to programmatically access the client object rendered for the chart in client-side script. This property is particularly important in referencing the chart 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 chart’s client identifier is generated automatically and equals the value of the chart’s ID property. Note that in this case, client-side programmatic access to the chart by its ID is not allowed when the chart is contained within a naming container.

Special Characters in Client Instance Name

If the ClientInstanceName property contains special characters, for instance, the dot (.), you cannot access a client object by this name. Call the GetByName(name) method to retrieve the client-side object instead.

<dx:ASPxTextBox ... ClientInstanceName="SomeType.SomeProp" />

var txt = ASPxClientControl.GetControlCollection().GetByName("SomeType.SomeProp");  
txt.SetText("Some Text");