CaptchaValidationSettings.ErrorDisplayMode Property

Gets or sets a value that specifies how an error message is represented within the editor’s error frame.

Namespace: DevExpress.Web.Captcha

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue(ErrorDisplayMode.Text)]
public ErrorDisplayMode ErrorDisplayMode { get; set; }

VB.NET

<DefaultValue(ErrorDisplayMode.Text)>
Public Property ErrorDisplayMode As ErrorDisplayMode

Property Value

Type	Default	Description
ErrorDisplayMode	Text	One of the ErrorDisplayMode enumeration values.

Available values:

Name	Description
Text	An error message is represented by text only.
ImageWithTooltip	An error message is represented by an error image. The image’s tooltip displays an error text. If an assigned error image is incorrect, an error message is represented by an error text directly.
ImageWithText	An error message is represented by both an error image and error text.
None	No error message is displayed, a specific error frame is displayed near the editor instead.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to ErrorDisplayMode
ASP.NET Web Forms Controls	ASPxCaptcha	.ValidationSettings .ErrorDisplayMode
ASP.NET MVC Extensions	CaptchaSettings	.ValidationSettings .ErrorDisplayMode

Remarks

The default value of this property depends upon whether an editor is used as standalone or as inplace (within, for example, the ASPxGridView). For a standalone editor, the ErrorDisplayMode property’s default value is ErrorDisplayMode.ImageWithText. For an inplace editor, the default value is ErrorDisplayMode.ImageWithTooltip.

Example

The following part of the ASPxCaptcha - Features online demo illustrates how to customize the challenge image‘s style settings.

These settings are specified within a panel (ASPxComboBox, ASPxColorEdit editors) and applied to the captcha control via the Apply button (ASPxButton).

C#

protected void btnApply_Click(object sender, EventArgs e) {
...
    int parseResult = 0;
    Captcha.ChallengeImage.FontFamily = cbFontFamily.Value.ToString();
    Captcha.ChallengeImage.ForegroundColor = ceForegroundColor.Color;
    Captcha.ChallengeImage.BackgroundColor = ceBackgroundColor.Color;
    Captcha.ChallengeImage.BorderColor = ceBorderColor.Color;
    if (int.TryParse(seBorderWidth.Text, out parseResult))
        Captcha.ChallengeImage.BorderWidth = parseResult;
...
}

ASPX

<dx:ASPxCaptcha ID="Captcha" runat="server" Width="402px">
    <ValidationSettings ErrorDisplayMode="Text">
    </ValidationSettings>
</dx:ASPxCaptcha>
...
<dx:ASPxComboBox ID="cbFontFamily" runat="server" Width="170px" ValueType="System.String">
    <Items>
        <dx:ListEditItem Text="Times New Roman" Value="Times New Roman" />
        <dx:ListEditItem Text="Courier New" Value="Courier New" />
        <dx:ListEditItem Text="Georgia" Value="Georgia" />
        <dx:ListEditItem Text="Tahoma" Value="Tahoma" />
        <dx:ListEditItem Text="Verdana" Value="Verdana" />
    </Items>
</dx:ASPxComboBox>
...
<dx:ASPxColorEdit ID="ceForegroundColor" runat="server" Width="170px">
</dx:ASPxColorEdit>
...
<dx:ASPxColorEdit ID="ceBackgroundColor" runat="server" Width="170px">
</dx:ASPxColorEdit>
...
<dx:ASPxColorEdit ID="ceBorderColor" runat="server" Width="170px">
</dx:ASPxColorEdit>
...
<dx:ASPxSpinEdit ID="seBorderWidth" Width="50px" runat="server" MaxValue="10">
</dx:ASPxSpinEdit>
...
<dx:ASPxButton ID="btnApply" CssClass="DemoButton" runat="server" Text="Apply" 
Width="70px" OnClick="btnApply_Click" />