RecaptchaControl Class

This class encapsulates reCAPTCHA UI and logic into an ASP.NET server control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.UIControls.RecaptchaControl

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23

Syntax

public class RecaptchaControl : WebControl, 
	IValidator

The RecaptchaControl type exposes the following members.

Constructors

	Name	Description
Public method	RecaptchaControl	Initializes a new instance of the RecaptchaControl class.

Methods

	Name	Description
Protected method	OnPreRender	Control pre-render event (Overrides Control.OnPreRender(EventArgs).)
Protected method	Render	Control render event. (Overrides WebControl.Render(HtmlTextWriter).)
Protected method	RenderContents	Render control contents. (Overrides WebControl.RenderContents(HtmlTextWriter).)
Public method	Validate	Perform validation of reCAPTCHA.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	AllowMultipleInstances	Allow multiple instances.
Public property	CustomThemeWidget	reCAPTCHA custom theme widget.
Public property	CustomTranslations	reCAPTCHA custom translations.
Public property	ErrorMessage	Validation error message.
Public property	IsClonnedInstance	Indicates whether this control takes advantage of other control's reCaptcha or has its own.
Public property	IsValid	Indicates if validation was successful.
Public property	Language	reCAPTCHA language.
Public property	OverrideSecureMode	Override reCAPTCHA secure API.
Public property	PrivateKey	reCAPTCHA private API key.
Public property	Proxy	reCAPTCHA proxy used to validate.
Public property	PublicKey	reCAPTCHA public API key.
Public property	SkipRecaptcha	Skip reCAPTCHA validation.
Public property	Theme	reCAPTCHA theme to be used.