Click or drag to resize
GeneralSelector Class
Represents an general selector form component.
Inheritance Hierarchy
SystemObject
  Kentico.Forms.Web.MvcFormComponent
    Kentico.Forms.Web.MvcFormComponentGeneralSelectorProperties, IEnumerableGeneralSelectorItem
      Kentico.Components.Web.Mvc.Selectors.InternalObjectSelectorComponentBaseGeneralSelectorProperties, GeneralSelectorItem
        Kentico.Components.Web.Mvc.FormComponentsGeneralSelector

Namespace: Kentico.Components.Web.Mvc.FormComponents
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 13.0.131
Syntax
C#
public class GeneralSelector : ObjectSelectorComponentBase<GeneralSelectorProperties, GeneralSelectorItem>

The GeneralSelector type exposes the following members.

Constructors
  NameDescription
Public methodGeneralSelector
Creates a new instance of GeneralSelector.
Top
Fields
  NameDescription
Public fieldStatic memberIDENTIFIER
Represents the GeneralSelector 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 propertyInstanceIdentifier
Gets the selector instance identifier.
(Inherited from ObjectSelectorComponentBaseTProperties, TSelectorItem.)
Public propertyLabelForPropertyName
Gets the name of the property representing the editing field in the resulting HTML markup. The name is used to infer a proper label for attribute value in the rendered HTML markup. Defaults to first found property annotated with BindablePropertyAttribute.
(Inherited from FormComponent.)
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.)
Protected propertySelectedItemValues
Gets the currently selected typed values.
(Inherited from ObjectSelectorComponentBaseTProperties, TSelectorItem.)
Public propertySelectedValue
Represents the serialized selected value.
(Inherited from ObjectSelectorComponentBaseTProperties, TSelectorItem.)
Public propertySelectorPropertyDescriptor
Gets the component property descriptor which identifies the component property that uses this selector.
(Inherited from ObjectSelectorComponentBaseTProperties, TSelectorItem.)
Protected propertySerializerSettings
The selector serialization settings used across all selector serializations and deserializations.
(Inherited from ObjectSelectorComponentBaseTProperties, TSelectorItem.)
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 ObjectSelectorComponentBaseTProperties, TSelectorItem.)
Public methodGetDisplayName
Returns non-localized string representing component name. Component Name is returned in case of empty Label.
(Inherited from FormComponent.)
Public methodGetItemsEndpointUrl
Gets the endpoint URL that provides data for the selector component.
(Overrides ObjectSelectorComponentBaseTProperties, TSelectorItemGetItemsEndpointUrl.)
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 methodGetSelectedListItems
Returns selected objects as list items.
(Overrides ObjectSelectorComponentBaseTProperties, TSelectorItemGetSelectedListItems.)
Public methodGetValue
Gets the value of the form component. Implement in a subclass to return value of a desired property. Method can also be used to return a value composed of multiple properties if required.
(Inherited from ObjectSelectorComponentBaseTProperties, TSelectorItem.)
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 value of the form component. Implement in a subclass to set value of a desired property. Method can also be used to decompose passed value into several properties rendered in the resulting form component markup.
(Inherited from ObjectSelectorComponentBaseTProperties, TSelectorItem.)
Public methodValidate
Determines whether the specified object is valid. Only invoked if validation by validation attributes passes for all fields.
(Inherited from ObjectSelectorComponentBaseTProperties, TSelectorItem.)
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