Table of Contents

Class DropDownComponentBase<TProperties, TClientProperties>

Namespace
Kentico.Xperience.Admin.Base.Forms
Assembly
Kentico.Xperience.Admin.Base.dll

Represents a base class for drop-down components.

public abstract class DropDownComponentBase<TProperties, TClientProperties> : FormComponent<TProperties, TClientProperties, string>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem where TProperties : DropDownProperties, new() where TClientProperties : DropDownClientProperties, new()

Type Parameters

TProperties
TClientProperties
Inheritance
object
FormComponent<TProperties, TClientProperties, string>
DropDownComponentBase<TProperties, TClientProperties>
Implements
Derived
Inherited Members
Extension Methods

Constructors

DropDownComponentBase(ILocalizationService)

Creates an instance of DropDownComponentBase<TProperties, TClientProperties> class.

public DropDownComponentBase(ILocalizationService localizationService)

Parameters

localizationService ILocalizationService

The system localization service.

Methods

ConfigureClientProperties(TClientProperties)

Configures the form component client properties.

protected override Task ConfigureClientProperties(TClientProperties clientProperties)

Parameters

clientProperties TClientProperties

The current instance of the form component client properties.

Returns

Task

Remarks

Override this method in order to configure form component client properties.

GetOptions()

Gets the options for the drop-down.

protected Task<IEnumerable<DropDownOptionItem>> GetOptions()

Returns

Task<IEnumerable<DropDownOptionItem>>

GetValue()

Gets the value of the component. Returns null if currently set value is not one of the available options.

public override string GetValue()

Returns

string