ASPxValidationSummary.ClientInstanceName Property
Gets or sets the editor’s client programmatic identifier.
Namespace: DevExpress.Web
Assembly: DevExpress.Web.v24.2.dll
Declaration
Property Value
| Type | Default | Description |
|---|---|---|
| String | String.Empty | A string value that specifies the editor’s client identifier. |
Remarks
Use the ClientInstanceName property to specify a unique client-side identifier for an editor. The ClientInstanceName property’s value can be used on the client side to programmatically access the client object, rendered for the editor in client-side script. This property is particularly important in referencing the editor, 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, an editor’s client identifier is generated automatically, and equals the value of the editor’s ID property. Note that in this case, client-side programmatic access to the editor by its ID is not allowed when the editor 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");
Example
The following section of the Validation Summary online demo illustrates how to customize the settings of the ASPxValidationSummary control.
This settings are specified within a panel by using the ASPxRadioButtonList, ASPxCheckBox editors.
protected void Page_Load(object sender, EventArgs e) {
ApplyValidationSummarySettings();
ApplyEditorsSettings();
if(!IsPostBack && !IsCallback)
ASPxEdit.ValidateEditorsInContainer(this);
}
private void ApplyValidationSummarySettings() {
vsValidationSummary1.RenderMode = (ValidationSummaryRenderMode)Enum.Parse(typeof
(ValidationSummaryRenderMode), rblRenderMode.SelectedItem.Value.ToString());
vsValidationSummary1.ShowErrorAsLink = chbShowErrorAsLink.Checked;
}
private void ApplyEditorsSettings() {
ASPxEdit[] editors = new ASPxEdit[] { tbName, tbEmail };
foreach(ASPxEdit editor in editors) {
editor.ValidationSettings.ValidateOnLeave = chbValidateOnLeave.Checked;
editor.ValidationSettings.SetFocusOnError = chbSetFocusOnError.Checked;
}
}