Click or drag to resize
DropDownComponent Class
Represents component displaying drown down list.
Inheritance Hierarchy
SystemObject
  Kentico.Forms.Web.MvcFormComponent
    Kentico.Forms.Web.MvcFormComponentDropDownProperties, String
      Kentico.Forms.Web.MvcSelectorFormComponentDropDownProperties
        Kentico.Forms.Web.MvcDropDownComponent
          Kentico.Forms.Web.MvcConsentSelectorComponent

Namespace: Kentico.Forms.Web.Mvc
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 13.0.131
Syntax
C#
public class DropDownComponent : SelectorFormComponent<DropDownProperties>

The DropDownComponent type exposes the following members.

Constructors
  NameDescription
Public methodDropDownComponent
Top
Fields
  NameDescription
Public fieldStatic memberIDENTIFIER
Represents the DropDownComponent 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 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 the collection of items populated in component.
(Inherited from SelectorFormComponentTProperties.)
Public propertyItems Obsolete.
Gets the collection of items populated in component.

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.

(Inherited from SelectorFormComponentTProperties.)
Public propertyLabelForPropertyName
Gets name of the SelectedValue property.
(Inherited from SelectorFormComponentTProperties.)
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 propertySelectedValue
Gets or sets value selected by component.
(Inherited from SelectorFormComponentTProperties.)
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 information to the form component. The actual type of context depends on where the component is being used.

The component can throw an exception if being used in a context for which it is not designed. The base implementation provided by this class must be called prior to throwing an exception, however.

(Inherited from FormComponent.)
Public methodGetDisplayName
Returns non-localized string representing component name. Component Name is returned in case of empty Label.
(Inherited from FormComponent.)
Protected methodGetHtmlOptions
Returns collection of items populated in component.
(Inherited from SelectorFormComponentTProperties.)
Protected methodGetItems Obsolete.
Returns collection of items populated in component.

This method is obsolete. Use GetHtmlOptions method instead.

(Inherited from SelectorFormComponentTProperties.)
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.)
Public methodGetValue
Gets the SelectedValue property.
(Overrides SelectorFormComponentTPropertiesGetValue.)
Public methodLoadProperties
Loads properties of the form component. The actual properties type must match the PropertiesType.
(Inherited from SelectorFormComponentTProperties.)
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 SelectedValue property.
(Inherited from SelectorFormComponentTProperties.)
Public methodValidate
Performs validation on SelectedValue property checking whether such value is present in HtmlOptions.
(Inherited from SelectorFormComponentTProperties.)
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
See Also