Table of Contents

Class ConsentAgreementComponent

Namespace
Kentico.Forms.Web.Mvc
Assembly
Kentico.Content.Web.Mvc.dll

Represents a consent agreement form component.

public class ConsentAgreementComponent : FormComponent<ConsentAgreementProperties, Guid?>
Inheritance
object
ConsentAgreementComponent
Inherited Members
Extension Methods

Fields

IDENTIFIER

Represents the ConsentAgreementComponent identifier.

public const string IDENTIFIER = "Kentico.ConsentAgreement"

Field Value

string

Properties

CheckboxEnabled

Represents whether checkbox should be enabled.

public bool CheckboxEnabled { get; }

Property Value

bool

ConsentChecked

Represents the input value in the resulting HTML.

public bool ConsentChecked { get; set; }

Property Value

bool

LabelForPropertyName

Gets name of the ConsentChecked property.

public override string LabelForPropertyName { get; }

Property Value

string

Methods

BindContext(FormComponentContext)

Binds biz form to component.

public override void BindContext(FormComponentContext context)

Parameters

context FormComponentContext

GetValue()

Returns null. Value of consent agreement GUID is set to the corresponding BizFormItem before the item is saved using the BizFormItemHandler event.

public override Guid? GetValue()

Returns

Guid?

SetValue(Guid?)

Sets the ConsentChecked based on value.

public override void SetValue(Guid? value)

Parameters

value Guid?

Validate(ValidationContext)

Validates whether selected ConsentInfo exists.

public override IEnumerable<ValidationResult> Validate(ValidationContext validationContext)

Parameters

validationContext ValidationContext

Returns

IEnumerable<ValidationResult>