Back to Devexpress

ASPxGaugeControl.ClientInstanceName Property

aspnet-devexpress-dot-web-dot-aspxgauges-dot-aspxgaugecontrol-6946d8b7.md

latest2.7 KB
Original Source

ASPxGaugeControl.ClientInstanceName Property

Gets or sets the ASPxGaugeControl‘s client programmatic identifier.

Namespace : DevExpress.Web.ASPxGauges

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

NuGet Package : DevExpress.Web.Visualization

Declaration

csharp
[DefaultValue("")]
public string ClientInstanceName { get; set; }
vb
<DefaultValue("")>
Public Property ClientInstanceName As String

Property Value

TypeDefaultDescription
StringString.Empty

A string value that specifies the control’s client identifier.

|

Remarks

Use the ClientInstanceName property to specify a unique client-side identifier for the ASPxGaugeControl control. The ClientInstanceName property’s value can be used on the client-side to programmatically access the client object rendered for the ASPxGaugeControl control in client-side script.

If the ClientInstanceName property is not specified for a control, the control’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 control is not allowed when the control 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.

aspx
<dx:ASPxTextBox ... ClientInstanceName="SomeType.SomeProp" />
js
var txt = ASPxClientControl.GetControlCollection().GetByName("SomeType.SomeProp");  
txt.SetText("Some Text");

See Also

ASPxGaugeControl Class

ASPxGaugeControl Members

DevExpress.Web.ASPxGauges Namespace