ConsentSelectorComponent Class

Provides drop-down list for selecting text of ConsentInfo.

Inheritance Hierarchy

System.Object
  Kentico.Forms.Web.Mvc.FormComponent
    Kentico.Forms.Web.Mvc.FormComponent<DropDownProperties, String>
      Kentico.Forms.Web.Mvc.SelectorFormComponent<DropDownProperties>
        Kentico.Forms.Web.Mvc.DropDownComponent
          Kentico.Forms.Web.Mvc.ConsentSelectorComponent

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

Syntax

public class ConsentSelectorComponent : DropDownComponent

The ConsentSelectorComponent type exposes the following members.

Constructors

	Name	Description
Public method	ConsentSelectorComponent

Fields

	Name	Description
Public field Static member	IDENTIFIER	Represents the ConsentSelectorComponent 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	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 the collection of items populated in component. (Inherited from SelectorFormComponent<TProperties>.)
Public property	Items	Obsolete. Gets the collection of items populated in component. 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. (Inherited from SelectorFormComponent<TProperties>.)
Public property	LabelForPropertyName	Gets name of the SelectedValue property. (Inherited from SelectorFormComponent<TProperties>.)
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	SelectedValue	Gets or sets value selected by component. (Inherited from SelectorFormComponent<TProperties>.)
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 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 method	GetDisplayName	Returns non-localized string representing component name. Component Name is returned in case of empty Label. (Inherited from FormComponent.)
Protected method	GetHtmlOptions	Returns data source containing ConsentName and ConsentDisplayName pairs, for populating drop-down list. (Overrides SelectorFormComponent<TProperties>.GetHtmlOptions().)
Protected method	GetItems	Obsolete. Returns collection of items populated in component. This method is obsolete. Use GetHtmlOptions() method instead. (Inherited from SelectorFormComponent<TProperties>.)
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>.)
Public method	GetValue	Gets the SelectedValue property. (Inherited from DropDownComponent.)
Public method	LoadProperties	Loads option label property. (Overrides SelectorFormComponent<TProperties>.LoadProperties(FormComponentProperties).)
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 SelectedValue property. (Inherited from SelectorFormComponent<TProperties>.)
Public method	Validate	Validates whether valid consent is selected. (Overrides SelectorFormComponent<TProperties>.Validate(ValidationContext).)

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