CompareToFieldSelectorComponent Class

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

Inheritance Hierarchy

System.Object
  Kentico.Forms.Web.Mvc.FormComponent
    Kentico.Forms.Web.Mvc.FormComponent<CompareToFieldSelectorProperties, Guid>
      Kentico.Forms.Web.Mvc.CompareToFieldSelectorComponent

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

Syntax

public class CompareToFieldSelectorComponent : FormComponent<CompareToFieldSelectorProperties, Guid>

The CompareToFieldSelectorComponent type exposes the following members.

Constructors

	Name	Description
Public method	CompareToFieldSelectorComponent

Fields

	Name	Description
Public field Static member	IDENTIFIER	Represents the CompareToFieldSelectorComponent 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	FieldGuid	Represents the selector value in the resulting HTML.
Public property	FieldNames	Obsolete. Gets enumeration of available fields to populate the selector. This property is obsolete. Use HtmlOptions property instead. Use ToSelectListItems(IEnumerable<HtmlOptionItem>) extension method to map an enumeration of HtmlOptionItem to enumeration of SelectListItem within Razor views.
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	HtmlOptions	Gets enumeration of available fields to populate the selector.
Public property	LabelForPropertyName	Gets name of the FieldGuid property. (Overrides FormComponent.LabelForPropertyName.)
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	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	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.)

Methods

	Name	Description
Public method	BindContext	Binds contextual values from a PropertiesPanelComponentContext instance. The component cannot work in any other context. (Overrides FormComponent.BindContext(FormComponentContext).)
Public method	GetDisplayName	Returns non-localized string representing component name. Component Name is returned in case of empty Label. (Inherited from FormComponent.)
Protected method	GetFieldNameOptions	Gets enumeration of available fields to populate the selector.
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>.)
Protected method	GetSelectListItems	Obsolete. Gets enumeration of available fields to populate the selector. This method is obsolete. Use GetFieldNameOptions() method instead.
Public method	GetValue	Gets the selected field GUID, if any field is available for selection. (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	Sets the selected field GUID. (Overrides FormComponent<TProperties, TValue>.SetValue(TValue).)
Public method	Validate	Determines whether the specified object is valid. Only invoked if validation by validation attributes passes for all fields. (Inherited from FormComponent.)

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.)

Remarks

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