aspnet-devexpress-dot-web-dot-aspxspreadsheet-dot-aspxspreadsheet-0b168ba7.md
Gets or sets the ASPxSpreadsheet‘s client programmatic identifier.
Namespace : DevExpress.Web.ASPxSpreadsheet
Assembly : DevExpress.Web.ASPxSpreadsheet.v25.2.dll
NuGet Package : DevExpress.Web.Office
[DefaultValue("")]
public string ClientInstanceName { get; set; }
<DefaultValue("")>
Public Property ClientInstanceName As String
| Type | Default | Description |
|---|---|---|
| String | String.Empty |
A string value that specifies the ASPxSpreadsheet‘s client identifier.
|
Use the ClientInstanceName property to specify a unique client-side identifier for the ASPxSpreadsheet control. The ClientInstanceName property’s value can be used on the client side to programmatically access the client object rendered for the ASPxSpreadsheet control in client-side script. This property is particularly important in referencing the ASPxSpreadsheet control when it is contained within a naming container (for instance, within an ASPxPopupControl‘s window).
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.
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");
See Also