HTMLCaptcha API Reference

Below the members of the HTMLCaptcha object are listed for reference.

Public Constructors

void Captcha() Initializes a new instance of the Captcha class.

Public Properties

int SelectedCaptcha Index to the selected CAPTCHA image.
string SelectedDescriptor The text representing the generated CAPTCHA
string CaptchaDataFolder Input folder of CAPTCHA data (index and cache)
string CaptchaDataFile Input filename for CAPTCHA image cache (default: "htcap.dat")
string CaptchaIndex Input filename for the CAPTCHA image cache index (default: "htcap.szb")
string CssRowClass CSS class name for generated CAPTCHA image "row" <div> elements (default: "htcap-row")
string CssColClass CSS class name for generated CAPTCHA image "column" <div> elements (default: "htcap-col")
string CssStyles Actual CSS style string based on CssRowClass and CssColClass values
bool CompressHtmlOutput Flag to optimize HTML image output
int MaxSelectEntries Number of descriptors to return. Must be 2 or greater, and must be set immediately after Init(). Default: 5
bool ModifyPixels Set to true and HTMLCaptcha will make slight, random modifications to pixel values of image. Default: false

Public Methods

void Init(string myCaptchaDataFolder) Initializes HTMLCaptcha. myCaptchaDataFolder is the path to the HTML image cache
string OutputCaptcha() Returns random HTML encoded image from image cache
ListItemCollection DescriptorList() Returns a ListItemCollection of descriptors which can be bound to ASP.NET controls such as a drop-down.
string [] DescriptorList(bool a) Returns string array of the descriptors.