Skip to main content

ASPxObjectContainer.ClientInstanceName Property

Gets or sets the ASPxObjectContainer‘s client programmatic identifier.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v22.1.dll

NuGet Package: DevExpress.Web


public string ClientInstanceName { get; set; }

Property Value

Type Default Description
String String.Empty

A string value that specifies the ASPxObjectContainer‘s client identifier.


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

Note that it’s not recommended to define the same identifier for the ID and ClientInstanceName properties of the ASPxObjectContainer control. Doing this might lead to a JavaScript error generated when accessing the control on the client, using the ClientInstanceName property’s value. As a workaround, you can add a “window.” prefix when accessing the control:


But, it’s better to use different names for the ASPxObjectContainer‘s ID and ClientInstanceName properties, and the ClientInstanceName property’s value shouldn’t coincide with any HTML element identifier on that specific page.


The client-side programmatic interface is available if the ASPxObjectContainer.EnableClientSideAPI property is set to true.

See Also