Click or drag to resize
CompareToFieldSelectorComponent Class
Selector component for selecting a field to compare against in validation rules based on comparison to another field.
Inheritance Hierarchy
SystemObject
  Kentico.Forms.Web.MvcFormComponent
    Kentico.Forms.Web.MvcFormComponentCompareToFieldSelectorProperties, Guid
      Kentico.Forms.Web.MvcCompareToFieldSelectorComponent

Namespace: Kentico.Forms.Web.Mvc
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 13.0.131
Syntax
C#
public class CompareToFieldSelectorComponent : FormComponent<CompareToFieldSelectorProperties, Guid>

The CompareToFieldSelectorComponent type exposes the following members.

Constructors
  NameDescription
Public methodCompareToFieldSelectorComponent
Top
Fields
  NameDescription
Public fieldStatic memberIDENTIFIER
Represents the CompareToFieldSelectorComponent identifier.
Top
Properties
  NameDescription
Public propertyBaseProperties
Gets the form component's properties as its base type.
(Inherited from FormComponentTProperties, TValue.)
Public propertyCustomAutopostHandling
If true, prevents built-in visibility condition handling for this component.
(Inherited from FormComponent.)
Public propertyDefinition
Gets or sets the definition under which the form component is registered in the system.
(Inherited from FormComponent.)
Public propertyFieldGuid
Represents the selector value in the resulting HTML.
Public propertyFieldNames Obsolete.
Gets enumeration of available fields to populate the selector.

This property is obsolete. Use HtmlOptions property instead. Use ToSelectListItems(IEnumerableHtmlOptionItem) extension method to map an enumeration of HtmlOptionItem to enumeration of SelectListItem within Razor views.

Public propertyHasDependingFields
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 propertyHtmlOptions
Gets enumeration of available fields to populate the selector.
Public propertyLabelForPropertyName
Gets name of the FieldGuid property.
(Overrides FormComponentLabelForPropertyName.)
Public propertyName
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 propertyProperties
Gets the form component's properties.
(Inherited from FormComponentTProperties, TValue.)
Public propertyPropertiesType
Gets the properties type of the form component.
(Inherited from FormComponent.)
Public propertyShowPartialValidationMessages
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.)
Top
Methods
  NameDescription
Public methodBindContext
Binds contextual values from a PropertiesPanelComponentContext instance. The component cannot work in any other context.
(Overrides FormComponentBindContext(FormComponentContext).)
Public methodGetDisplayName
Returns non-localized string representing component name. Component Name is returned in case of empty Label.
(Inherited from FormComponent.)
Protected methodGetFieldNameOptions
Gets enumeration of available fields to populate the selector.
Public methodGetModelPropertyCustomAttributesT
Gets a collection of custom attributes applied to the model's property this form component represents.
(Inherited from FormComponent.)
Public methodGetObjectValue
Gets the value of the form component. The GetValue method can be used directly to obtain the typed value.
(Inherited from FormComponentTProperties, TValue.)
Protected methodGetSelectListItems Obsolete.
Gets enumeration of available fields to populate the selector.

This method is obsolete. Use GetFieldNameOptions method instead.

Public methodGetValue
Gets the selected field GUID, if any field is available for selection.
(Overrides FormComponentTProperties, TValueGetValue.)
Public methodLoadProperties
Loads properties of the form component. The actual properties type must match the PropertiesType.
(Inherited from FormComponentTProperties, TValue.)
Public methodModifyMetadata
Modifies modelMetadata according to the current object.
(Inherited from FormComponent.)
Public methodSetObjectValue
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.)
Public methodSetValue
Sets the selected field GUID.
(Overrides FormComponentTProperties, TValueSetValue(TValue).)
Public methodValidate
Determines whether the specified object is valid. Only invoked if validation by validation attributes passes for all fields.
(Inherited from FormComponent.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetBizFormComponentContext
Gets BizFormComponentContext of a form component, if such a context was bound to the component.
(Defined by FormComponentExtensions.)
Top
Remarks
Implementation of the selector is bound to PropertiesPanelComponentContext and can be used in the Form builder's properties panel only.
See Also