BotDetect ASP.NET CAPTCHA Configuration API Reference

BotDetect ASP.NET Captcha exposes a configuration facade over the underlying configuration implementation reading BotDetect settings from .NET .config files.

BotDetect.CaptchaConfiguration

Main BotDetect configuration access point.

BotDetect.CaptchaConfiguration Class Reference
BotDetect.CaptchaConfiguration public property readonly static int? CodeLength Number of characters in randomly generated Captcha codes (answers to Captcha challenges).
BotDetect.CaptchaConfiguration public property readonly static BotDetect.CodeStyle CodeStyle Character types used to generate random Captcha codes.
BotDetect.CaptchaConfiguration public property readonly static System.Collection.Generic.List<T> <string> DisallowedCodeSubstrings Strings that should never occur in randomly generated Captcha codes. Can be both single characters (allows Captcha character set customization) and sequences of two or more characters (useful for swear words filtering, avoiding particular hard-to-read sequences etc.).
BotDetect.CaptchaConfiguration public property readonly static int CodeTimeout The time period after random Captcha code generation during which Captcha challenges based on it can be solved: when it expires, even correct inputs will be considered as invalid submissions.
BotDetect.CaptchaConfiguration public property readonly static bool TestModeEnabled Application configuration switch to use if you want to run automated tests that need to be able to submit a Captcha-protected form in QA environments.
BotDetect.CaptchaConfiguration public property readonly static BotDetect.ImageStyle? ImageStyle The BotDetect drawing algorithm used to render Captcha codes in image Captcha challenges.
BotDetect.CaptchaConfiguration public property readonly static BotDetect.ImageSize ImageSize Size of Captcha image challenges generated.
BotDetect.CaptchaConfiguration public property readonly static BotDetect.ImageFormat ImageFormat Image format in which Captcha images will be generated and sent to the client.
BotDetect.CaptchaConfiguration public property readonly static System.Drawing.Color CustomLightColor BotDetect allows Captcha image color scheme customization though two color points: a custom dark color and a custom light color.
BotDetect.CaptchaConfiguration public property readonly static System.Drawing.Color CustomDarkColor BotDetect allows Captcha image color scheme customization though two color points: a custom dark color and a custom light color.
BotDetect.CaptchaConfiguration public property readonly static BotDetect.Set<T> <BotDetect.ImageStyle> DisabledImageStyles Application configuration setting that allows centralized temporary disabling of individual BotDetect image styles if there is ever an urgent issue that requires it.
BotDetect.CaptchaConfiguration public property readonly static bool SoundEnabled Is Captcha sound enabled.
BotDetect.CaptchaConfiguration public property readonly static BotDetect.SoundStyle? SoundStyle The BotDetect audio generation algorithm used to pronounce Captcha codes in sound Captcha challenges.
BotDetect.CaptchaConfiguration public property readonly static BotDetect.SoundFormat SoundFormat Audio format in which Captcha sounds will be generated and sent to the client.
BotDetect.CaptchaConfiguration public property readonly static BotDetect.SoundRegenerationMode SoundRegenerationMode How will multiple consecutive requests for audio Captcha with the same Captcha code ("sound regeneration") be handled by BotDetect - a tradeoff of security, usability, and storage requirements.
BotDetect.CaptchaConfiguration public property readonly static string SoundPackagesFolder Application configuration setting controlling the file system location of BotDetect sound resources required for Captcha audio.
BotDetect.CaptchaConfiguration public property readonly static bool WarnAboutMissingSoundPackages Application configuration setting that controls whether BotDetect disables (greys-out and prevents clicks on) the Captcha sound icon and displays a warning tooltip when the sound package file containing character pronunciations for the currently set Captcha locale can not be found.
BotDetect.CaptchaConfiguration public property readonly static BotDetect.Set<T> <BotDetect.SoundStyle> DisabledSoundStyles Application configuration setting that allows centralized temporary disabling of individual BotDetect sound styles if there is ever an urgent issue that requires it.
BotDetect.CaptchaConfiguration public property readonly static string Locale Captcha locale string, determining the exact character set used for random Captcha code generation and the pronunciation language used for sound Captcha generation.
BotDetect.CaptchaConfiguration public property readonly static string ImageTooltip The alternative text of the Captcha image Html element.
BotDetect.CaptchaConfiguration public property readonly static string SoundTooltip Tooltip of the Captcha sound icon.
BotDetect.CaptchaConfiguration public property readonly static string ReloadTooltip Tooltip of the Captcha reload icon.
BotDetect.CaptchaConfiguration public property readonly static string HelpLinkText Text or tooltip of the Captcha help link, depending on help link mode.
BotDetect.CaptchaConfiguration public property readonly static string HelpLinkUrl Url of the localized Captcha help page the help link points to.
BotDetect.CaptchaConfiguration public property readonly static string ReloadEnabled Is Captcha reloading (changing the Captcha code because the current one is too hard to read) enabled.
BotDetect.CaptchaConfiguration public property readonly static bool? UseSmallIcons Default BotDetect Captcha icons are 22x22 pixels large, but there is also a smaller set of 17x17 px icons used when the default ones are too large. This settings allows you to control which icon set will be used.
BotDetect.CaptchaConfiguration public property readonly static bool? UseHorizontalIcons BotDetect displays the Captcha sound and reload icon one below the other by default, and switches to displaying them one beside the other when Captcha images are small enough. This setting allows you to control which BotDetect icon layout will be used.
BotDetect.CaptchaConfiguration public property readonly static string SoundIconUrl Url of the optional custom Captcha sound icon that will be used instead of the default one.
BotDetect.CaptchaConfiguration public property readonly static string ReloadIconUrl Url of the optional custom Captcha reload icon that will be used instead of the default one.
BotDetect.CaptchaConfiguration public property readonly static System.Int32? IconsDivWidth Custom width of the Captcha icons div element.
BotDetect.CaptchaConfiguration public property readonly static bool HelpLinkEnabled Will Captcha markup include a link to a Captcha help page providing Captcha instructions and explanations for form users.
BotDetect.CaptchaConfiguration public property readonly static BotDetect.HelpLinkMode HelpLinkMode How will the Captcha help link be displayed.
BotDetect.CaptchaConfiguration public property readonly static string AdditionalCssClasses User-defined CSS classes that will be added to the BotDetect CAPTCHA container <div>.
BotDetect.CaptchaConfiguration public property readonly static string AdditionalInlineCss User-defined CSS style declarations that will be added as inline style of the BotDetect CAPTCHA container <div>.
BotDetect.CaptchaConfiguration public property readonly static bool AddScriptInclude Should the BotDetect JavaScript client-side script code be included by the generated Captcha container markup.
BotDetect.CaptchaConfiguration public property readonly static bool AddInitScript Should the JavaScript code for BotDetect client-side object creation be included in the generated Captcha container markup.
BotDetect.CaptchaConfiguration public property readonly static bool AutoUppercaseInput Should user Captcha code input be automatically uppercased on the fly.
BotDetect.CaptchaConfiguration public property readonly static bool AutoFocusInput Should the Captcha code input textbox automatically be assigned focus on all Captcha sound and Captcha reload icon clicks, allowing the users to more easily type in the code as they hear it or as the new image loads.
BotDetect.CaptchaConfiguration public property readonly static bool AutoClearInput Should the Captcha user input textbox automatically be cleared on all reload icon clicks and auto-reloads of expired Captcha codes.
BotDetect.CaptchaConfiguration public property readonly static bool AutoReloadExpiredCaptchas Should Captcha challenges automatically be reloaded when the Captcha code expires (controlled by the CodeTimeout property).
BotDetect.CaptchaConfiguration public property readonly static bool AutoReloadTimeout Time period in seconds after which automatic reloading of expired Captcha challenges will cease.
BotDetect.CaptchaConfiguration public property readonly static int SoundStartDelay Starting delay (in milliseconds) of Captcha audio JavaScript playback. The default value is 0 (no delay).
BotDetect.CaptchaConfiguration public property readonly static bool RemoteScriptEnabled Should BotDetect also add a remote JavaScript include (remote.captcha.com/include.js) loaded from the captcha.com server (which is currently used only for stats, but is planned to develop into additional Captcha functionality).
BotDetect.CaptchaConfiguration public property readonly static string HttpHandlerRequestPath Path of the BotDetect ASP.NET HttpHandler used for processing Captcha image, sound and Ajax validation requests, as well as accessing all BotDetect public resources (Captcha icons, layout stylesheet, client-script include).
BotDetect.CaptchaConfiguration public property readonly static bool HttpHandlerTroubleshootingEnabled Should Captcha HttpHandler diagnostics be run.
BotDetect.CaptchaConfiguration public property readonly static bool RequestFilterEnabled Should the custom Captcha Http request validator be run.
BotDetect.CaptchaConfiguration public property readonly static int RequestFilterRepeatedRequestsAllowed How many repeated Captcha HttpHandler requests using the exact same query string will be allowed in a short time period.
BotDetect.CaptchaConfiguration public property readonly static bool SessionTroubleshootingEnabled Should Captcha Session state persistence diagnostics be run.
BotDetect.CaptchaConfiguration public property readonly static string SessionIdEncryptionPassword Password used to generate the encryption key used for obscuring SessionID values required for the BotDetect CustomSessionIDManager to work around cookie limitations of sound playback in certain browsers.
BotDetect.CaptchaConfiguration public property readonly static string LoggingProvider Fully-qualified name of a .NET class implementing the BotDetect.Logging.ILoggingProvider interface, loaded by the current ASP.NET application and used to process all BotDetect logging calls.
BotDetect.CaptchaConfiguration public property readonly static bool ErrorLoggingEnabled Should exceptions originating in BotDetect code be logged to the currently active Captcha logging provider.
BotDetect.CaptchaConfiguration public property readonly static bool TraceLoggingEnabled Should a detailed trace of the Captcha generation and validation workflow be logged to the currently active Captcha logging provider.
BotDetect.CaptchaConfiguration public property readonly static bool TraceLoggingEventFilter Filter which Captcha events will be included in the BotDetect trace log.

[back to the top of the page]


© Captcha, Inc. 2004-2023. All rights reserved.

BotDetect, BotDetect CAPTCHA, Lanap, Lanap CAPTCHA, Lanap BotDetect, Lanap BotDetect CAPTCHA, Lanapsoft, Lanapsoft CAPTCHA, Lanapsoft BotDetect, Lanapsoft BotDetect CAPTCHA, and Lanap Software are trademarks of Captcha, Inc. All other product, brand, and company names are mentioned for identification purposes only and are trademarks or registered trademarks of their respective owners.

Captcha, Inc. -- formerly: Lanapsoft, Inc. / Lanap, Inc.