ASPxPivotGrid.ClientInstanceName Property

Gets or sets the pivot grid’s client programmatic identifier.

Namespace: DevExpress.Web.ASPxPivotGrid

Assembly: DevExpress.Web.ASPxPivotGrid.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 that specifies the pivot grid’s client identifier.

Remarks

Use the ClientInstanceName property to specify a unique client-side identifier for a pivot grid. The ClientInstanceName property’s value can be used on the client side to programmatically access the client object rendered for the pivot grid in client-side script. This property is particularly important in referencing the pivot grid 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 pivot grid’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 pivot grid by its ID is not allowed when the pivot grid is contained within a naming container.

The pivot grid’s client instance is represented by the ASPxClientPivotGrid class.

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