Table of Contents

Class CompareToFieldSelectorComponent

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

Selector component for selecting a field to compare against in validation rules based on comparison to another field.

public class CompareToFieldSelectorComponent : FormComponent<CompareToFieldSelectorProperties, Guid>
Inheritance
object
CompareToFieldSelectorComponent
Inherited Members
Extension Methods

Remarks

Implementation of the selector is bound to PropertiesPanelComponentContext and can be used in the Form builder's properties panel only.

Fields

IDENTIFIER

Represents the CompareToFieldSelectorComponent identifier.

public const string IDENTIFIER = "Kentico.CompareToFieldSelector"

Field Value

string

Properties

FieldGuid

Represents the selector value in the resulting HTML.

public Guid FieldGuid { get; set; }

Property Value

Guid

HtmlOptions

Gets enumeration of available fields to populate the selector.

public IEnumerable<HtmlOptionItem> HtmlOptions { get; }

Property Value

IEnumerable<HtmlOptionItem>

LabelForPropertyName

Gets name of the FieldGuid property.

public override string LabelForPropertyName { get; }

Property Value

string

Methods

BindContext(FormComponentContext)

Binds contextual values from a PropertiesPanelComponentContext instance. The component cannot work in any other context.

public override void BindContext(FormComponentContext context)

Parameters

context FormComponentContext

Context to bind values from.

Exceptions

ArgumentException

Thrown when context is of any other type than PropertiesPanelComponentContext.

GetFieldNameOptions()

Gets enumeration of available fields to populate the selector.

protected virtual IEnumerable<HtmlOptionItem> GetFieldNameOptions()

Returns

IEnumerable<HtmlOptionItem>

GetValue()

Gets the selected field GUID, if any field is available for selection.

public override Guid GetValue()

Returns

Guid

SetValue(Guid)

Sets the selected field GUID.

public override void SetValue(Guid value)

Parameters

value Guid

See Also

CompareToFieldValidationRule<TValue>