Class CaptchaPropertiesBuilder

Represents the Captcha Properties.

Inheritance

System.Object

CaptchaPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

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

Assembly: Syncfusion.EJ.dll

Syntax

public class CaptchaPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

CaptchaPropertiesBuilder()

Initializes a new instance of the CaptchaPropertiesBuilder class.

Declaration

public CaptchaPropertiesBuilder()

CaptchaPropertiesBuilder(Captcha)

Initializes a new instance of the CaptchaPropertiesBuilder class.

Declaration

public CaptchaPropertiesBuilder(Captcha captcha)

Parameters

Type	Name	Description
Captcha	captcha	Accepts the Captcha properties

Fields

captcha

Declaration

protected Captcha captcha

Field Value

Type	Description
Captcha

Methods

CharacterSet(String)

Specifies the character set of the Captcha that will be used to generate captcha text randomly.

Declaration

public CaptchaPropertiesBuilder CharacterSet(string cset)

Parameters

Type	Name	Description
System.String	cset	cset

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns string value

ClientSideEvents(Action<CaptchaClientSideEventsBuilder>)

Captcha ClientSideEvents

Declaration

public CaptchaPropertiesBuilder ClientSideEvents(Action<CaptchaClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<CaptchaClientSideEventsBuilder>	clientSideEvents	clientSideEvents

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns captcha properties builder value

CustomErrorMessage(String)

Specifies the error message to be displayed when the Captcha mismatch.

Declaration

public CaptchaPropertiesBuilder CustomErrorMessage(string errorMessage)

Parameters

Type	Name	Description
System.String	errorMessage	errorMessage

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns string value

EnableAudio(Boolean)

Sets the Captcha with audio support, that enables to dictate the captcha text.

Declaration

public CaptchaPropertiesBuilder EnableAudio(bool enableAudio)

Parameters

Type	Name	Description
System.Boolean	enableAudio	enableAudio

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns enable audio value which is of boolean type

EnableAutoValidation(Boolean)

Set the Captcha validation automatically.

Declaration

public CaptchaPropertiesBuilder EnableAutoValidation(bool autoValidate)

Parameters

Type	Name	Description
System.Boolean	autoValidate	autoValidate

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns boolean value

EnableCaseSensitivity(Boolean)

Specifies the case sensitivity for the characters typed in the Captcha.

Declaration

public CaptchaPropertiesBuilder EnableCaseSensitivity(bool caseSensitive)

Parameters

Type	Name	Description
System.Boolean	caseSensitive	caseSensitive

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns boolean value

EnablePattern(Boolean)

Specifies the background appearance for the captcha.

Declaration

[Obsolete("EnablePattern has been deprecated. Use HatchStyle API ")]
public CaptchaPropertiesBuilder EnablePattern(bool enablePattern)

Parameters

Type	Name	Description
System.Boolean	enablePattern	enablePattern

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns enable pattern value which is of string type

EnableRefreshImage(Boolean)

Sets the Captcha with a refresh button.

Declaration

public CaptchaPropertiesBuilder EnableRefreshImage(bool enableRefreshImage)

Parameters

Type	Name	Description
System.Boolean	enableRefreshImage	enableRefreshImage

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns boolean value

EnableRTL(Boolean)

Sets the Captcha direction as right to left alignment.

Declaration

public CaptchaPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL	enableRTL

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns boolean value

ForeColor(Color)

Specifies the Captcha text color.

Declaration

public CaptchaPropertiesBuilder ForeColor(Color txtcolcor)

Parameters

Type	Name	Description
System.Drawing.Color	txtcolcor

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns string value

HatchStyle(HatchStyle)

Specifies the background appearance for the captcha.

Declaration

public CaptchaPropertiesBuilder HatchStyle(HatchStyle hatch)

Parameters

Type	Name	Description
HatchStyle	hatch	hatch

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns enum value

Height(Int32)

Specifies the height of the Captcha.

Declaration

public CaptchaPropertiesBuilder Height(int height)

Parameters

Type	Name	Description
System.Int32	height	height

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns number value

Locale(String)

Different culture can be given locale property, Text present in place holder will be localized to respective culture.

Declaration

public CaptchaPropertiesBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
CaptchaPropertiesBuilder

MaximumLength(Int32)

Specifies the maximum number of characters used in the Captcha.

Declaration

public CaptchaPropertiesBuilder MaximumLength(int maxlength)

Parameters

Type	Name	Description
System.Int32	maxlength	maxlength

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns number value

MinimumLength(Int32)

Specifies the minimum number of characters used in the Captcha.

Declaration

public CaptchaPropertiesBuilder MinimumLength(int minimumLength)

Parameters

Type	Name	Description
System.Int32	minimumLength	minimumLength

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns number value

PatternBackColor(Color)

Specifies the background color for Captcha.

Declaration

public CaptchaPropertiesBuilder PatternBackColor(Color backcolcor)

Parameters

Type	Name	Description
System.Drawing.Color	backcolcor

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns string value

PatternForeColor(Color)

Specifies the background pattern color.

Declaration

public CaptchaPropertiesBuilder PatternForeColor(Color bgforecolor)

Parameters

Type	Name	Description
System.Drawing.Color	bgforecolor	bgforecolor

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns string value

Render()

Renders this instance.

Declaration

public void Render()

RequestMapper(String)

Specifies the method to map values to Captcha.

Declaration

public CaptchaPropertiesBuilder RequestMapper(string actionName)

Parameters

Type	Name	Description
System.String	actionName	actionName

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns string value

RequestMapper(String, String, RouteValueDictionary, String, String)

Specifies the method to map values to Captcha.

Declaration

public CaptchaPropertiesBuilder RequestMapper(string actionName, string controllerName, RouteValueDictionary routeValues, string protocol, string hostName)

Parameters

Type	Name	Description
System.String	actionName	actionName
System.String	controllerName	controllerName
System.Web.Routing.RouteValueDictionary	routeValues	routeValues
System.String	protocol	protocol
System.String	hostName	hostName

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns captcha properties builder value

ShowAudioButton(Boolean)

Sets the Captcha with audio support, that enables to dictate the captcha text.

Declaration

public CaptchaPropertiesBuilder ShowAudioButton(bool enableAudio)

Parameters

Type	Name	Description
System.Boolean	enableAudio	enableAudio

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns boolean value

ShowRefreshButton(Boolean)

Sets the Captcha with a refresh button.

Declaration

public CaptchaPropertiesBuilder ShowRefreshButton(bool enableRefreshImage)

Parameters

Type	Name	Description
System.Boolean	enableRefreshImage	enableRefreshImage

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns boolean value

TargetButton(String)

Specifies the target button of the Captcha to validate the entered text and captcha text.

Declaration

public CaptchaPropertiesBuilder TargetButton(string targetButton)

Parameters

Type	Name	Description
System.String	targetButton	targetButton

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns string value

TargetInput(String)

Specifies the target input element that will verify the Captcha.

Declaration

public CaptchaPropertiesBuilder TargetInput(string targetInput)

Parameters

Type	Name	Description
System.String	targetInput	targetInput

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns string value

ToHtmlString()

Returns an HTML-encoded string.

Declaration

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

Returns

Type	Description
System.String

Width(Int32)

Specifies the width of the Captcha.

Declaration

public CaptchaPropertiesBuilder Width(int width)

Parameters

Type	Name	Description
System.Int32	width	width

Returns

Type	Description
CaptchaPropertiesBuilder	This method returns number value

Implements

IPropertiesBuilder

System.Web.IHtmlString