Class FormFieldTextValueExtractorBase<TValue>

Namespace

CMS.OnlineForms

Assembly

CMS.OnlineForms.dll

Extractor used for extracting text representation of value from form fields.

public abstract class FormFieldTextValueExtractorBase<TValue>

Type Parameters

TValue

Inheritance

object

FormFieldTextValueExtractorBase<TValue>

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Remarks

The implementation of specific FormFieldTextValueExtractorBase<TValue> has to be registered in the IoC container as a singleton. For extraction of field value is used the last registered extractor which can extract value from the field determined by CanExtract(FormFieldExtractionContext).

Methods

CanExtract(FormFieldExtractionContext)

Determines whether the extractor can extract value from the specified form field.

public abstract Task<bool> CanExtract(FormFieldExtractionContext context)

Parameters

context FormFieldExtractionContext

Context for the field text extraction.

Returns

Task<bool>

Remarks

Used to indicate if the extractor can extract value from specific form field. You can create extractors for specific form components. If multiple extractors can extract value from the field, the last registered one is used.

See Also

GetFormComponentIdentifier(FormFieldExtractionContext)

Extract(TValue, FormFieldExtractionContext)

Extracts value from a form field.

public abstract Task<string> Extract(TValue value, FormFieldExtractionContext context)

Parameters

value TValue

The value to extract text from.

context FormFieldExtractionContext

Context for the field text extraction.

Returns

Task<string>

The extracted value as a string.

Remarks

If the TValue is a value type and the value is null, the method is not called and and empty string is returned instead.