ConsentAgreementComponent Class |
Namespace: Kentico.Forms.Web.Mvc
public class ConsentAgreementComponent : FormComponent<ConsentAgreementProperties, Nullable<Guid>>
The ConsentAgreementComponent type exposes the following members.
Name | Description | |
---|---|---|
ConsentAgreementComponent |
Name | Description | |
---|---|---|
IDENTIFIER |
Represents the ConsentAgreementComponent identifier.
|
Name | Description | |
---|---|---|
BaseProperties |
Gets the form component's properties as its base type.
(Inherited from FormComponentTProperties, TValue.) | |
CheckboxEnabled |
Represents whether checkbox should be enabled.
| |
ConsentChecked |
Represents the input value in the resulting HTML.
| |
CustomAutopostHandling |
If true, prevents built-in visibility condition handling for this component.
(Inherited from FormComponent.) | |
Definition |
Gets or sets the definition under which the form component is registered in the system.
(Inherited from FormComponent.) | |
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.) | |
LabelForPropertyName |
Gets name of the ConsentChecked property.
(Overrides FormComponentLabelForPropertyName.) | |
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.) | |
Properties |
Gets the form component's properties.
(Inherited from FormComponentTProperties, TValue.) | |
PropertiesType |
Gets the properties type of the form component.
(Inherited from FormComponent.) | |
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.) |
Name | Description | |
---|---|---|
BindContext |
Binds biz form to component.
(Overrides FormComponentBindContext(FormComponentContext).) | |
GetDisplayName |
Returns non-localized string representing component name.
Component Name is returned in case of empty Label.
(Inherited from FormComponent.) | |
GetModelPropertyCustomAttributesT |
Gets a collection of custom attributes applied to the model's property
this form component represents.
(Inherited from FormComponent.) | |
GetObjectValue |
Gets the value of the form component. The GetValue method can be used
directly to obtain the typed value.
(Inherited from FormComponentTProperties, TValue.) | |
GetValue |
Returns null. Value of consent agreement GUID is set to the corresponding BizFormItem before the item is saved using the BizFormItemHandler event.
(Overrides FormComponentTProperties, TValueGetValue.) | |
LoadProperties |
Loads properties of the form component. The actual properties type must match the PropertiesType.
(Inherited from FormComponentTProperties, TValue.) | |
ModifyMetadata |
Modifies modelMetadata according to the current object.
(Inherited from FormComponent.) | |
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 FormComponentTProperties, TValue.) | |
SetValue |
Sets the ConsentChecked based on value.
(Overrides FormComponentTProperties, TValueSetValue(TValue).) | |
Validate |
Validates whether selected ConsentInfo exists.
(Overrides FormComponentValidate(ValidationContext).) |
Name | Description | |
---|---|---|
GetBizFormComponentContext |
Gets BizFormComponentContext of a form component, if such a context was bound to the component.
(Defined by FormComponentExtensions.) |