RecaptchaProperties Class

Represents properties of a RecaptchaComponent.

Inheritance Hierarchy

System.Object
  Kentico.Forms.Web.Mvc.FormComponentProperties
    Kentico.Forms.Web.Mvc.FormComponentProperties<String>
      Kentico.Forms.Web.Mvc.RecaptchaProperties

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

Syntax

public class RecaptchaProperties : FormComponentProperties<string>

The RecaptchaProperties type exposes the following members.

Constructors

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

Fields

	Name	Description
Public field Static member	BOTTOM_LEFT	The bottom left badge position.
Public field Static member	BOTTOM_RIGHT	The bottom right badge position.
Public field Static member	INLINE	The inline badge position.
Public field Static member	RECAPTCHA_V2	reCAPTCHA v2
Public field Static member	RECAPTCHA_V3	reCAPTCHA v3

Properties

	Name	Description
Public property	Badge	Represents the position of the Protected by reCAPTCHA badge rendered on the page.
Public property	DataType	Gets or sets the underlying field data type. (Inherited from FormComponentProperties.)
Public property	DefaultValue	Gets or sets the default value of the form component and underlying field. (Overrides FormComponentProperties<TValue>.DefaultValue.)
Public property	ExplanationText	Gets or sets the explanation text of the form component. (Inherited from FormComponentProperties.)
Public property	Guid	Gets or sets the underlying field GUID. (Inherited from FormComponentProperties.)
Public property	Label	Gets or sets the label of the form component. Hidden for "invisible" recaptcha v3. (Overrides FormComponentProperties.Label.)
Public property	Layout	Represents the layout of the component (normal or compact).
Public property	Name	Gets or sets the underlying field name. (Inherited from FormComponentProperties.)
Public property	Placeholder	Gets or sets the value displayed as placeholder in the input. Override and annotate with EditingComponentAttribute to make this property editable in properties panel. (Inherited from FormComponentProperties.)
Public property	Precision	Gets or sets the underlying field precision. (Inherited from FormComponentProperties.)
Public property	Required	Gets or sets value indicating whether the underlying field is required. False by default. If false, the form component's implementation must accept nullable input. (Overrides FormComponentProperties.Required.)
Public property	Size	Gets or sets the underlying field size. (Inherited from FormComponentProperties.)
Public property	SmartField	Gets or sets value indicating whether the underlying field is smart field. False by default. (Overrides FormComponentProperties.SmartField.)
Public property	Theme	Represents the color theme of the component (light or dark).
Public property	Threshold	Represents the reCAPTCHA v3 score threshold for when the form submission should be rejected.
Public property	Tooltip	Gets or sets the tooltip of the form component. (Overrides FormComponentProperties.Tooltip.)
Public property	Type	Represents the type of the component (image or audio).
Public property	ValidationRuleConfigurations	Gets or sets validation rule configurations assigned to the form component. (Inherited from FormComponentProperties.)
Public property	Version	Represents the version of reCAPTCHA for the component to use (v2 or v3).
Public property	VisibilityConditionConfiguration	Gets or sets visibility condition configuration assigned to the form component. (Inherited from FormComponentProperties.)

Methods

	Name	Description
Public method	GetDefaultValue	Gets the default value. The DefaultValue property can be used directly to obtain the typed default value. (Inherited from FormComponentProperties<TValue>.)
Public method	SetDefaultValue	Sets the default value to value. The value must be of type TValue or an exception is thrown. The DefaultValue property can be used directly to set the typed default value. (Inherited from FormComponentProperties<TValue>.)