BotDetect ASP.NET CAPTCHA Events Reference (BotDetect v3.0; deprecated)

BotDetect ASP.NET Captcha uses a number of Captcha-specific events to allow detailed tracking of all phases in the Captcha workflow.

BotDetect.CaptchaEventArgs

Base Captcha-specific event arguments class.

Inherits

BotDetect.BaseEventArgs

BotDetect.CaptchaEventArgs Class Reference
BotDetect.CaptchaEventArgs public property string CaptchaId Identifies which Captcha does the event apply to

BotDetect.GeneratingCaptchaCodeEventArgs

Event arguments used for the GeneratingCaptchaCode event being fired before each random Captcha code generation.

Inherits

BotDetect.CaptchaEventArgs

BotDetect.GeneratingCaptchaCodeEventArgs Class Reference
BotDetect.GeneratingCaptchaCodeEventArgs public property string CaptchaId Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to
BotDetect.GeneratingCaptchaCodeEventArgs public property string CurrentInstanceId Globally unique identifier of the current Captcha instance generating the code
BotDetect.GeneratingCaptchaCodeEventArgs public property BotDetect.CodeCollection StoredCodes Captcha codes stored for this captchaId before the new code is generated

BotDetect.GeneratedCaptchaCodeEventArgs

Event arguments used for the GeneratedCaptchaCode event being fired after each random Captcha code generation.

Inherits

BotDetect.CaptchaEventArgs

BotDetect.GeneratedCaptchaCodeEventArgs Class Reference
BotDetect.GeneratedCaptchaCodeEventArgs public property string CaptchaId Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to
BotDetect.GeneratedCaptchaCodeEventArgs public property string CurrentInstanceId Globally unique identifier of the current Captcha instance which generated the code
BotDetect.GeneratedCaptchaCodeEventArgs public property string Code The random Captcha code generated
BotDetect.GeneratedCaptchaCodeEventArgs public property int CodeLength The Captcha code length used for code generation
BotDetect.GeneratedCaptchaCodeEventArgs public property BotDetect.CodeStyle CodeStyle The Captcha code style used for code generation
BotDetect.GeneratedCaptchaCodeEventArgs public property BotDetect. CodeGenerationPurpose Purpose Which purpose was the Captcha code generated for
BotDetect.GeneratedCaptchaCodeEventArgs public property BotDetect.CodeCollection StoredCodes Captcha codes stored for this captchaId after the new code has been generated

BotDetect.GeneratingCaptchaImageEventArgs

Event arguments used for the GeneratingCaptchaImage event being fired before each Captcha image generation.

Inherits

BotDetect.CaptchaEventArgs

BotDetect.GeneratingCaptchaImageEventArgs Class Reference
BotDetect.GeneratingCaptchaImageEventArgs public property string CaptchaId Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to
BotDetect.GeneratingCaptchaImageEventArgs public property string CurrentInstanceId Globally unique identifier of the current Captcha instance generating the image

BotDetect.GeneratedCaptchaImageEventArgs

Event arguments used for the GeneratedCaptchaImage event being fired after each Captcha image generation.

Inherits

BotDetect.CaptchaEventArgs

BotDetect.GeneratedCaptchaImageEventArgs Class Reference
BotDetect.GeneratedCaptchaImageEventArgs public property string CaptchaId Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to
BotDetect.GeneratedCaptchaImageEventArgs public property string CurrentInstanceId Globally unique identifier of the current Captcha instance which generated the image
BotDetect.GeneratedCaptchaImageEventArgs public property long Bytes Size of the generated image file
BotDetect.GeneratedCaptchaImageEventArgs public property System.Drawing.Size GdiImageSize Size of the generated image, in pixels
BotDetect.GeneratedCaptchaImageEventArgs public property BotDetect.ImageFormat ImageFormat Image format the Captcha image was generated in
BotDetect.GeneratedCaptchaImageEventArgs public property BotDetect.ImageStyle ImageStyle Image style used for Captcha image drawing

BotDetect.GeneratingCaptchaSoundEventArgs

Event arguments used for the GeneratingCaptchaSound event being fired before each Captcha sound generation.

Inherits

BotDetect.CaptchaEventArgs

BotDetect.GeneratingCaptchaSoundEventArgs Class Reference
BotDetect.GeneratingCaptchaSoundEventArgs public property string CaptchaId Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to
BotDetect.GeneratingCaptchaSoundEventArgs public property string CurrentInstanceId Globally unique identifier of the current Captcha instance generating the sound

BotDetect.GeneratedCaptchaSoundEventArgs

Event arguments used for the GeneratedCaptchaSound event being fired after each Captcha sound generation.

Inherits

BotDetect.CaptchaEventArgs

BotDetect.GeneratedCaptchaSoundEventArgs Class Reference
BotDetect.GeneratedCaptchaSoundEventArgs public property string CaptchaId Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to
BotDetect.GeneratedCaptchaSoundEventArgs public property string CurrentInstanceId Globally unique identifier of the current Captcha instance which generated the sound
BotDetect.GeneratedCaptchaSoundEventArgs public property long Bytes Size of the generated sound file
BotDetect.GeneratedCaptchaSoundEventArgs public property long Duration Duration of the generated sound file, in milliseconds
BotDetect.GeneratedCaptchaSoundEventArgs public property BotDetect.SoundStyle SoundStyle Sound style used for Captcha sound generation
BotDetect.GeneratedCaptchaSoundEventArgs public property BotDetect.SoundFormat SoundFormat Sound format the Captcha sound was generated in

BotDetect.ValidatingUserInputEventArgs

Event arguments used for the ValidatingUserInput event being fired before each Captcha validation.

Inherits

BotDetect.CaptchaEventArgs

BotDetect.ValidatingUserInputEventArgs Class Reference
BotDetect.ValidatingUserInputEventArgs public property string CaptchaId Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to
BotDetect.ValidatingUserInputEventArgs public property string CurrentInstanceId Globally unique identifier of the current Captcha instance validating the user input
BotDetect.ValidatingUserInputEventArgs public property string ValidatingInstanceId Globally unique identifier of the previous Captcha instance which generated the Captcha code
BotDetect.ValidatingUserInputEventArgs public property BotDetect. ValidationAttemptOrigin Origin Origin of the Captcha validation attempt
BotDetect.ValidatingUserInputEventArgs public property BotDetect.CodeCollection StoredCodes Captcha codes stored for this captchaId before Captcha validation
BotDetect.ValidatingUserInputEventArgs public property string UserInput User input that will be compared to stored codes

BotDetect.ValidatedUserInputEventArgs

Event arguments used for the ValidatedUserInput event being fired after each Captcha validation.

Inherits

BotDetect.CaptchaEventArgs

BotDetect.ValidatedUserInputEventArgs Class Reference
BotDetect.ValidatedUserInputEventArgs public property string CaptchaId Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to
BotDetect.ValidatedUserInputEventArgs public property string CurrentInstanceId Globally unique identifier of the current Captcha instance which validated the user input
BotDetect.ValidatedUserInputEventArgs public property string ValidatingInstanceId Globally unique identifier of the previous Captcha instance which generated the Captcha code
BotDetect.ValidatedUserInputEventArgs public property BotDetect. ValidationAttemptOrigin Origin Origin of the Captcha validation attempt
BotDetect.ValidatedUserInputEventArgs public property BotDetect.CodeCollection StoredCodes Captcha codes stored for this captchaId after user input was validated
BotDetect.ValidatedUserInputEventArgs public property string UserInput User input that was compared to stored codes
BotDetect.ValidatedUserInputEventArgs public property bool Result Captcha validation result

BotDetect.InitializedCaptchaControlEventArgs

Event arguments used for the InitializedCaptchaControl event being fired when each CaptchaControl instance is created.

Inherits

BotDetect.CaptchaEventArgs

BotDetect.InitializedCaptchaControlEventArgs Class Reference
BotDetect.InitializedCaptchaControlEventArgs public property string CaptchaId Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to

Please Note

The information on this page is out of date and applies to a deprecated version of BotDetect™ CAPTCHA (v3.0).

An up-to-date equivalent page for the latest BotDetect Captcha release (v4) is BotDetect v4 Captcha documentation index.

General information about the major improvements in the current BotDetect release can be found at the What's New in BotDetect v4.0 page.