Interface IDynamicFeatureDescriber

Namespace: EncDotNet.S100.DynamicSources

Assembly: EncDotNet.S100.Core.dll

Optional capability of an IDynamicFeatureSource: describes one of its features for a pick report as a title and a list of labelled, formatted values with their units.

public interface IDynamicFeatureDescriber

Remarks

A host's pick path checks the source for this interface. When it is present the host shows Title and Properties in place of its generic listing of Attributes. The source knows its values' meaning and units; the host doesn't have to. See docs/design/dynamic-source-pick.md.

Methods

Describe(DynamicFeature, IFormatProvider?)

Describes feature, one of this source's features.

DynamicFeatureDescription? Describe(DynamicFeature feature, IFormatProvider? formatProvider = null)

Parameters

feature DynamicFeature: The feature, from CurrentFeatures.
formatProvider IFormatProvider: The culture to format numbers and times with; null for the invariant culture.

Returns