ASPxEditBase.ClientInstanceName Property

Specifies the editor’s client programmatic identifier.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v18.2.dll

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

Remarks

This property is a wrapper of the EditPropertiesBase.ClientInstanceName property.

Note

If the ClientInstanceName property contains special characters, use the approach described in the following Knowledge Base Article to access the client-side programmatic object.

KA18687: How to use the ClientInstanceName and Name properties when they contain special characters

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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#

how-to-use-client-instances-of-devexpress-aspnet-controls-within-an-aspnet-user-control-e4671/CS/WebSite/ECControl.ascx.cs#L11

protected void Page_Load(Object sender, EventArgs e) {
    btnTime.ClientSideEvents.Click = String.Format("function() {{ {0}.SetText(GetCurrentTimeString()); }}", lblTime.ClientInstanceName);
}

instant-editing-of-boolean-field-value-using-two-columns-e1405/CS/BooleanRepresentation/Default.aspx.cs#L15

ASPxRadioButton inproduction = grid.FindRowCellTemplateControl(e.VisibleIndex, grid.Columns["InProduction"] as GridViewDataColumn, "btnInProduction") as ASPxRadioButton;
discontinued.ClientInstanceName = "btnDiscontinued" + e.VisibleIndex;
inproduction.ClientInstanceName = "btnInProduction" + e.VisibleIndex;

VB.NET

how-to-use-client-instances-of-devexpress-aspnet-controls-within-an-aspnet-user-control-e4671/VB/WebSite/ECControl.ascx.vb#L14

    lblTime.Text = DateTime.Now.ToString("HH:mm:ss")
    btnTime.ClientSideEvents.Click = String.Format("function() {{ {0}.SetText(GetCurrentTimeString()); }}", lblTime.ClientInstanceName)
End Sub

instant-editing-of-boolean-field-value-using-two-columns-e1405/VB/BooleanRepresentation/Default.aspx.vb#L17

Dim inproduction As ASPxRadioButton = TryCast(grid.FindRowCellTemplateControl(e.VisibleIndex, TryCast(grid.Columns("InProduction"), GridViewDataColumn), "btnInProduction"), ASPxRadioButton)
discontinued.ClientInstanceName = "btnDiscontinued" & e.VisibleIndex
inproduction.ClientInstanceName = "btnInProduction" & e.VisibleIndex