RecaptchaComponent Class

Represents a reCAPTCHA form component.

Inheritance Hierarchy

System.Object
  Kentico.Forms.Web.Mvc.FormComponent
    Kentico.Forms.Web.Mvc.FormComponent<RecaptchaProperties, String>
      Kentico.Forms.Web.Mvc.RecaptchaComponent

Namespace: Kentico.Forms.Web.Mvc
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 13.0.131

Syntax

public class RecaptchaComponent : FormComponent<RecaptchaProperties, string>

The RecaptchaComponent type exposes the following members.

Constructors

	Name	Description
Public method	RecaptchaComponent

Fields

	Name	Description
Public field Static member	IDENTIFIER	Represents the RecaptchaComponent identifier.

Properties

	Name	Description
Public property	BaseProperties	Gets the form component's properties as its base type. (Inherited from FormComponent<TProperties, TValue>.)
Public property	CustomAutopostHandling	If true, prevents built-in visibility condition handling for this component. (Inherited from FormComponent.)
Public property	Definition	Gets or sets the definition under which the form component is registered in the system. (Inherited from FormComponent.)
Public property	HasDependingFields	Gets or sets a value indicating whether there are another form components whose visibility condition depends on this component's value. (Inherited from FormComponent.)
Public property	IsConfigured	Determines whether the component is configured and allowed to be displayed.
Public property	IsV3	Indicates whether or not the component is configured to use reCAPTCHA V3
Public property	LabelForPropertyName	Label "for" cannot be used for this component. (Overrides FormComponent.LabelForPropertyName.)
Public property	Language	Optional. Forces the reCAPTCHA to render in a specific language. Auto-detects the user's language if unspecified. Currently supported values are listed at https://developers.google.com/recaptcha/docs/language.
Public property	Name	Gets or sets the name of the corresponding form field. The name is used as a prefix when naming the HTML input. (Inherited from FormComponent.)
Public property	PrivateKey	reCAPTCHA v2 private key from https://www.google.com/recaptcha/admin.
Public property	PrivateKeyV3	reCAPTCHA v3 private key from https://www.google.com/recaptcha/admin.
Public property	Properties	Gets the form component's properties. (Inherited from FormComponent<TProperties, TValue>.)
Public property	PropertiesType	Gets the properties type of the form component. (Inherited from FormComponent.)
Public property	PublicKey	reCAPTCHA v2 site key from https://www.google.com/recaptcha/admin.
Public property	PublicKeyV3	reCAPTCHA v3 site key from https://www.google.com/recaptcha/admin.
Public property	ShowPartialValidationMessages	Also shows validation errors of partial values of the component. If false, each individual component should contain validation message in its partial view. (Inherited from FormComponent.)
Public property	Value	Holds nothing and is here just because it is required.

Methods

	Name	Description
Public method	BindContext	Binds contextual information to the form component. The actual type of context depends on where the component is being used. The component can throw an exception if being used in a context for which it is not designed. The base implementation provided by this class must be called prior to throwing an exception, however. (Inherited from FormComponent.)
Public method	GetDisplayName	Returns non-localized string representing component name. Component Name is returned in case of empty Label. (Inherited from FormComponent.)
Public method	GetModelPropertyCustomAttributes<T>	Gets a collection of custom attributes applied to the model's property this form component represents. (Inherited from FormComponent.)
Public method	GetObjectValue	Gets the value of the form component. The GetValue() method can be used directly to obtain the typed value. (Inherited from FormComponent<TProperties, TValue>.)
Public method	GetValue	Returns empty string since the Value does not hold anything. (Overrides FormComponent<TProperties, TValue>.GetValue().)
Public method	LoadProperties	Loads properties of the form component. The actual properties type must match the PropertiesType. (Inherited from FormComponent<TProperties, TValue>.)
Public method	ModifyMetadata	Modifies modelMetadata according to the current object. (Inherited from FormComponent.)
Public method	SetObjectValue	Sets the value of the form component. The value must be of proper type or an exception is thrown. The SetValue(TValue) method can be used directly to set the typed default value. (Inherited from FormComponent<TProperties, TValue>.)
Public method	SetValue	Does nothing since the Value does not need to hold anything. (Overrides FormComponent<TProperties, TValue>.SetValue(TValue).)
Public method	Validate	Performs validation of the reCAPTCHA component. (Overrides FormComponent.Validate(ValidationContext).)

Extension Methods

	Name	Description
Public Extension Method	GetBizFormComponentContext	Gets BizFormComponentContext of a form component, if such a context was bound to the component. (Defined by FormComponentExtensions.)