ASPxGridBase.ClientInstanceName Property

Gets or sets the control’s client programmatic identifier.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v23.2.dll

NuGet Package: DevExpress.Web

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 control’s client identifier.

Remarks

Use the ClientInstanceName property to specify a unique client-side identifier for the grid control. The ClientInstanceName property’s value can be used on the client side to programmatically access the client object rendered for the grid control in client-side script. This property is particularly important in referencing the grid 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.

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");  

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ClientInstanceName property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

asp-net-web-forms-grid-created-at-runtime-switch-data-sources/CS/Solution/Default.aspx.cs#L53

grid.AutoGenerateColumns = true;
grid.ClientInstanceName = "grid";
grid.DataBind();

VB.NET

asp-net-web-forms-grid-created-at-runtime-switch-data-sources/VB/Solution/Default.aspx.vb#L55

grid.AutoGenerateColumns = True
grid.ClientInstanceName = "grid"
grid.DataBind()