Open sandboxFocus

Property Description

Description

Gets an optional human-readable description of Object, suitable for inclusion in error messages.

Declaration
FormattableString? Description { get; }
Property Value
Type Description
FormattableString
Remarks

This property returns a FormattableString that can be embedded directly in eligibility error messages. The framework's custom formatter ensures proper rendering of declarations.

When writing justification messages in MustSatisfy<T>(IEligibilityBuilder<T>, Predicate<T>, Func<IDescribedObject<T>, FormattableString>), you can use the IDescribedObject<T> parameter directly in interpolated strings, and it will be formatted appropriately.