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 class
- BotDetect.GeneratingCaptchaCodeEventArgs class
- BotDetect.GeneratedCaptchaCodeEventArgs class
- BotDetect.GeneratingCaptchaImageEventArgs class
- BotDetect.GeneratedCaptchaImageEventArgs class
- BotDetect.GeneratingCaptchaSoundEventArgs class
- BotDetect.GeneratedCaptchaSoundEventArgs class
- BotDetect.ValidatingUserInputEventArgs class
- BotDetect.ValidatedUserInputEventArgs class
- BotDetect.InitializedCaptchaControlEventArgs class
BotDetect.CaptchaEventArgs
Base Captcha-specific event arguments class.
Inherits
BotDetect.BaseEventArgs
| BotDetect.CaptchaEventArgs Class Reference | ||
|---|---|---|
 |
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.GeneratingCaptchaCodeEventArgs Class Reference | ||
|---|---|---|
|
string CaptchaId | Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to |
|
string CurrentInstanceId | Globally unique identifier of the current Captcha instance generating the code |
|
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.GeneratedCaptchaCodeEventArgs Class Reference | ||
|---|---|---|
|
string CaptchaId | Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to |
|
string CurrentInstanceId | Globally unique identifier of the current Captcha instance which generated the code |
|
string Code | The random Captcha code generated |
|
int CodeLength | The Captcha code length used for code generation |
|
BotDetect.CodeStyle CodeStyle | The Captcha code style used for code generation |
|
BotDetect. CodeGenerationPurpose Purpose | Which purpose was the Captcha code generated for |
|
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.GeneratingCaptchaImageEventArgs Class Reference | ||
|---|---|---|
|
string CaptchaId | Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to |
|
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.GeneratedCaptchaImageEventArgs Class Reference | ||
|---|---|---|
|
string CaptchaId | Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to |
|
string CurrentInstanceId | Globally unique identifier of the current Captcha instance which generated the image |
|
long Bytes | Size of the generated image file |
|
System.Drawing.Size GdiImageSize | Size of the generated image, in pixels |
|
BotDetect.ImageFormat ImageFormat | Image format the Captcha image was generated in |
|
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.GeneratingCaptchaSoundEventArgs Class Reference | ||
|---|---|---|
|
string CaptchaId | Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to |
|
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.GeneratedCaptchaSoundEventArgs Class Reference | ||
|---|---|---|
|
string CaptchaId | Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to |
|
string CurrentInstanceId | Globally unique identifier of the current Captcha instance which generated the sound |
|
long Bytes | Size of the generated sound file |
|
long Duration | Duration of the generated sound file, in milliseconds |
|
BotDetect.SoundStyle SoundStyle | Sound style used for Captcha sound generation |
|
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.ValidatingUserInputEventArgs Class Reference | ||
|---|---|---|
|
string CaptchaId | Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to |
|
string CurrentInstanceId | Globally unique identifier of the current Captcha instance validating the user input |
|
string ValidatingInstanceId | Globally unique identifier of the previous Captcha instance which generated the Captcha code |
|
BotDetect. ValidationAttemptOrigin Origin | Origin of the Captcha validation attempt |
|
BotDetect.CodeCollection StoredCodes | Captcha codes stored for this captchaId before Captcha validation |
|
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.ValidatedUserInputEventArgs Class Reference | ||
|---|---|---|
|
string CaptchaId | Inherited from CaptchaEventArgs, identifies which Captcha does the event apply to |
|
string CurrentInstanceId | Globally unique identifier of the current Captcha instance which validated the user input |
|
string ValidatingInstanceId | Globally unique identifier of the previous Captcha instance which generated the Captcha code |
|
BotDetect. ValidationAttemptOrigin Origin | Origin of the Captcha validation attempt |
|
BotDetect.CodeCollection StoredCodes | Captcha codes stored for this captchaId after user input was validated |
|
string UserInput | User input that was compared to stored codes |
|
bool Result | Captcha validation result |
BotDetect.InitializedCaptchaControlEventArgs
Event arguments used for the InitializedCaptchaControl event being fired when each CaptchaControl instance is created.
Inherits
| BotDetect.InitializedCaptchaControlEventArgs Class Reference | ||
|---|---|---|
|
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.
Current BotDetect Versions
-
BotDetect ASP.NET CAPTCHA
2019-07-22v4.4.2 -
BotDetect Java CAPTCHA
2019-07-22v4.0.Beta3.7 -
BotDetect PHP CAPTCHA
2019-07-22v4.2.5
