CaptchaImage Class

CaptchaImage Class

KaxCaptcha image generation class

Inheritance Hierarchy

SystemObject
Kettic.AspNet.ControlsCaptchaImage

Namespace: Kettic.AspNet.Controls
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)

Syntax

C++

Copy

[SerializableAttribute]
public class CaptchaImage

<SerializableAttribute>
Public Class CaptchaImage

[SerializableAttribute]
public ref class CaptchaImage

[<SerializableAttribute>]
type CaptchaImage =  class end

The CaptchaImage type exposes the following members.

Constructors

	Name	Description
	CaptchaImage
	CaptchaImage(CaptchaImage, Random, DateTime, String)

Top

Methods

	Name	Description
	RenderImage	Forces a new Captcha image to be generated using current property value settings.

Top

Properties

	Name	Description
	AudioFilesPath	Gets or sets the path to the directory where the audio (.wav) files are located. The default value is ~/App_Data/KaxCaptcha.
	BackgroundColor	Gets or sets the background color of the CaptchaImage.
	BackgroundNoise	Gets or sets the amount of background noise to generate in the KaxCaptcha image.
	CharSet	Gets or sets a custom Character Set, from which the characters used to render KaxCaptcha, are randomly chosen. The TextChars property must be set to CustomCharSet.
	EnableCaptchaAudio	Gets or sets the bool value indicating whether the CaptchaAudio will be enabled.
	FontFamily	Gets or sets the font used to render KaxCaptcha text.
	FontWarp	Gets or sets the amount of random font warping used on the KaxCaptcha text.
	FontWhitelist	Gets or sets a semicolon-delimited list of valid fonts to use when no font is provided.
	Height	Gets or sets the height of the KaxCaptcha image.
	ImageAlternativeText	Gets or sets the KaxCaptcha image alternative text.
	ImageCssClass	Gets or sets the KaxCaptcha image CSS class.
	LineNoise	Gets or sets the line noise level to the KaxCaptcha image.
	RenderedAt	Gets the date and time this image was last rendered
	RenderImageOnly	Gets or sets bool value that indicates whether the KaxCaptcha Image will only be rendered on the page (without the textbox and Label).
	Text	Gets the randomly generated KaxCaptcha text.
	TextChars	Gets or sets the characters used to render KaxCaptcha text. A character will be picked randomly from the string.
	TextColor	Gets or sets the color of the KaxCaptcha text.
	TextLength	Gets or sets the number of CaptchaChars used in the KaxCaptcha text.
	UniqueId	Gets a GUID that uniquely identifies this KaxCaptcha
	UseAudioFiles	Gets or sets a bool value indicating whether the audio code will be generated by concatenation of the audio files from a given folder.
	UseRandomFont	Gets or sets a bool value indicating whether a random font will be used to generate the CaptchaImage text.
	Width	Gets or sets the width of the KaxCaptcha image.

Top

Reference

Kettic.AspNet.Controls Namespace