Class CaptchaProperties

Represents the Captcha UI element.

Inheritance

System.Object

CaptchaProperties

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript.Models

Assembly: Syncfusion.EJ.dll

Syntax

public class CaptchaProperties

Constructors

CaptchaProperties()

Declaration

public CaptchaProperties()

Fields

imageValue

Declaration

public string imageValue

Field Value

Type	Description
System.String

refreshPanelMaximunHeight

Declaration

public int refreshPanelMaximunHeight

Field Value

Type	Description
System.Int32

refreshPanelMinimumHeight

Declaration

public int refreshPanelMinimumHeight

Field Value

Type	Description
System.Int32

refreshPanelMinimumWidth

Declaration

public int refreshPanelMinimumWidth

Field Value

Type	Description
System.Int32

Properties

AudioUrl

Gets or sets the audio url.

Declaration

[JsonProperty("audioUrl")]
public string AudioUrl { get; set; }

Property Value

Type	Description
System.String	The audio url.

CharacterSet

Gets or sets the character set of the Captcha that will be used to generate captcha text randomly.

Declaration

[JsonProperty("characterSet")]
public string CharacterSet { get; set; }

Property Value

Type	Description
System.String	The character set.

Create

Declaration

[JsonProperty("create")]
public string Create { get; set; }

Property Value

Type	Description
System.String

CustomErrorMessage

Gets or sets the error message to be displayed when the Captcha mismatch.

Declaration

[JsonProperty("customErrorMessage")]
public string CustomErrorMessage { get; set; }

Property Value

Type	Description
System.String	true if [customErrorMessage]; otherwise, false

EnableAudio

Declaration

[Obsolete("EnableAudio has been deprecated. Use ShowAudioButton API ")]
[JsonIgnore]
public bool EnableAudio { get; set; }

Property Value

Type	Description
System.Boolean

EnableAutoValidation

Gets or sets the enable auto validation.

Declaration

[JsonProperty("enableAutoValidation")]
public bool EnableAutoValidation { get; set; }

Property Value

Type	Description
System.Boolean	true if [enableAutoValidation]; otherwise, false

EnableCaseSensitivity

Gets or sets the case sensitivity for the characters typed in the Captcha.

Declaration

[JsonProperty("enableCaseSensitivity")]
public bool EnableCaseSensitivity { get; set; }

Property Value

Type	Description
System.Boolean	true if [enableCaseSensitivity]; otherwise, false

EnablePattern

Declaration

[Obsolete("EnablePattern has been deprecated. Use HatchStyle API ")]
[JsonProperty("enablePattern")]
public bool EnablePattern { get; set; }

Property Value

Type	Description
System.Boolean

EnableRefreshImage

Declaration

[JsonIgnore]
[Obsolete("EnableRefreshImage has been deprecated. Use ShowRefreshButton API")]
public bool EnableRefreshImage { get; set; }

Property Value

Type	Description
System.Boolean

EnableRTL

Gets or sets the Captcha direction as right to left alignment.

Declaration

[JsonProperty("enableRTL")]
public bool EnableRTL { get; set; }

Property Value

Type	Description
System.Boolean	true if [enableRTL]; otherwise, false

EncryptedCode

Gets or sets the captcha characters.

Declaration

[JsonProperty("encryptedCode")]
public string EncryptedCode { get; set; }

Property Value

Type	Description
System.String	The encrypted code.

ForeColor

Gets or sets the Captcha text color.

Declaration

[JsonIgnore]
public Color ForeColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	The fore color

HatchStyle

Gets or sets the background appearance for the captcha.

Declaration

[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("hatchStyle")]
public HatchStyle HatchStyle { get; set; }

Property Value

Type	Description
HatchStyle	The hatch style

Height

Gets or sets the height of the Captcha.

Declaration

[JsonProperty("height")]
public int Height { get; set; }

Property Value

Type	Description
System.Int32	The height.

Locale

Gets or sets the different culture can be given locale property, Text present in place holder will be localized to respective culture.

Declaration

[JsonProperty("locale")]
public string Locale { get; set; }

Property Value

Type	Description
System.String	The locale.

Mapper

Gets or sets the method with values to be mapped in the Captcha.

Declaration

[JsonProperty("mapper")]
public string Mapper { get; set; }

Property Value

Type	Description
System.String	The mapper

MaximumLength

Gets or sets the maximum number of characters used in the Captcha.

Declaration

[JsonProperty("maximumLength")]
public int MaximumLength { get; set; }

Property Value

Type	Description
System.Int32	The maximum length.

MinimumLength

Gets or sets the minimum number of characters used in the Captcha.

Declaration

[JsonProperty("minimumLength")]
public int MinimumLength { get; set; }

Property Value

Type	Description
System.Int32	The minimum length.

PathName

Gets or sets the pathname.

Declaration

[JsonProperty("pathName")]
public string PathName { get; set; }

Property Value

Type	Description
System.String	The path name.

PatternBackColor

Gets or sets the background color for Captcha.

Declaration

[JsonIgnore]
public Color PatternBackColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	The pattern back color.

PatternForeColor

Gets or sets the background pattern color.

Declaration

[JsonIgnore]
public Color PatternForeColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	The pattern fore color.

RefreshBegin

Occurs when captcha refresh begins.

Declaration

[JsonProperty("refreshBegin")]
public string RefreshBegin { get; set; }

Property Value

Type	Description
System.String	The refresh begin.

RefreshComplete

Occurs after captcha refresh completed.

Declaration

[JsonProperty("refreshComplete")]
public string RefreshComplete { get; set; }

Property Value

Type	Description
System.String	The refresh complete.

RefreshFailure

Occurs when captcha refresh fails to load.

Declaration

[JsonProperty("refreshFailure")]
public string RefreshFailure { get; set; }

Property Value

Type	Description
System.String	The refresh failure.

RefreshSuccess

Occurs after captcha refresh succeeded.

Declaration

[JsonProperty("refreshSuccess")]
public string RefreshSuccess { get; set; }

Property Value

Type	Description
System.String	The refresh success.

RequestMapper

Gets or sets the method to map values to Captcha.

Declaration

[JsonProperty("requestMapper")]
public string RequestMapper { get; set; }

Property Value

Type	Description
System.String	The request mapper.

ShowAudioButton

Gets or sets the Captcha with audio support, that enables to dictate the captcha text.

Declaration

[JsonProperty("showAudioButton")]
public bool ShowAudioButton { get; set; }

Property Value

Type	Description
System.Boolean	true if [showAudioButton]; otherwise, false

ShowRefreshButton

Gets or sets the Captcha with a refresh button.

Declaration

[JsonProperty("showRefreshButton")]
public bool ShowRefreshButton { get; set; }

Property Value

Type	Description
System.Boolean	true if [showRefreshButton]; otherwise, false

TargetButton

Gets or sets the target button of the Captcha to validate the entered text and captcha text.

Declaration

[JsonProperty("targetButton")]
public string TargetButton { get; set; }

Property Value

Type	Description
System.String	The target button.

TargetInput

Gets or sets the target input element that will verify the Captcha.

Declaration

[JsonProperty("targetInput")]
public string TargetInput { get; set; }

Property Value

Type	Description
System.String	The target input.

Width

Gets or sets the width of the Captcha.

Declaration

[JsonProperty("width")]
public int Width { get; set; }

Property Value

Type	Description
System.Int32	The width.

Methods

Generate(Int32, String, Int32)

Generates Random Text

Declaration

public static string Generate(int maxlength, string captchaChars, int minimumLength)

Parameters

Type	Name	Description
System.Int32	maxlength
System.String	captchaChars
System.Int32	minimumLength

Returns

Type	Description
System.String

RenderCaptchaImage()

Renders the captcha image

Declaration

[Obsolete("EnablePattern has been deprecated. Use HatchStyle API ")]
public string RenderCaptchaImage()

Returns

Type	Description
System.String