File: ModelExplorerExtensions.cs
Web Access
Project: src\src\Mvc\Mvc.ViewFeatures\src\Microsoft.AspNetCore.Mvc.ViewFeatures.csproj (Microsoft.AspNetCore.Mvc.ViewFeatures)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Diagnostics;
using System.Globalization;
 
namespace Microsoft.AspNetCore.Mvc.ViewFeatures;
 
/// <summary>
/// Extension methods for <see cref="ModelExplorer"/>.
/// </summary>
public static class ModelExplorerExtensions
{
    /// <summary>
    /// Gets a simple display string for the <see cref="ModelExplorer.Model"/> property
    /// of <paramref name="modelExplorer"/>.
    /// </summary>
    /// <param name="modelExplorer">The <see cref="ModelExplorer"/>.</param>
    /// <returns>A simple display string for the model.</returns>
    /// <remarks>
    /// The result is obtained from the following sources (the first success wins):
    /// <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.SimpleDisplayProperty" />,
    /// <see cref="ModelExplorer.Model" /> converted to string (if the result is interesting),
    /// the first internal property converted to string,
    /// <see cref="P:Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata.NullDisplayText"  />
    /// (when the value is <see langword="null" />).
    /// This method is not recursive in order to prevent an infinite loop.
    /// </remarks>
    public static string GetSimpleDisplayText(this ModelExplorer modelExplorer)
    {
        ArgumentNullException.ThrowIfNull(modelExplorer);
 
        if (modelExplorer.Metadata.SimpleDisplayProperty != null)
        {
            var propertyExplorer = modelExplorer.GetExplorerForProperty(
                modelExplorer.Metadata.SimpleDisplayProperty);
            if (propertyExplorer?.Model != null)
            {
                return propertyExplorer.Model.ToString();
            }
        }
 
        if (modelExplorer.Model == null)
        {
            return modelExplorer.Metadata.NullDisplayText;
        }
 
        if (modelExplorer.Metadata.IsEnum && modelExplorer.Model is Enum modelEnum)
        {
            var enumStringValue = modelEnum.ToString("d");
            var enumGroupedDisplayNamesAndValues = modelExplorer.Metadata.EnumGroupedDisplayNamesAndValues;
 
            Debug.Assert(enumGroupedDisplayNamesAndValues != null);
 
            foreach (var kvp in enumGroupedDisplayNamesAndValues)
            {
                if (string.Equals(kvp.Value, enumStringValue, StringComparison.Ordinal))
                {
                    return kvp.Key.Name;
                }
            }
        }
 
        var stringResult = Convert.ToString(modelExplorer.Model, CultureInfo.CurrentCulture);
        if (stringResult == null)
        {
            return string.Empty;
        }
 
        if (!stringResult.Equals(modelExplorer.Model.GetType().FullName, StringComparison.Ordinal))
        {
            return stringResult;
        }
 
        if (modelExplorer.PropertiesInternal.Length == 0)
        {
            return string.Empty;
        }
 
        var firstProperty = modelExplorer.PropertiesInternal[0];
 
        if (firstProperty.Model == null)
        {
            return firstProperty.Metadata.NullDisplayText;
        }
 
        return Convert.ToString(firstProperty.Model, CultureInfo.CurrentCulture);
    }
}