如何从 ModelMetadata 检索 GroupName 数据注释

Question

System.ComponentModel.DataAnnotations 中的 DisplayAttribute 有一个 GroupName 属性，它允许您在 UI 控件（例如 WPF/WinForms 中的属性网格）中对字段进行逻辑分组。

我正在尝试在 ASP.NET MVC3 应用程序中访问此元数据，本质上是为了创建属性网格。如果我的模型看起来像这样：

public class Customer
{
    [ReadOnly]
    public int Id { get;set; }

    [Display(Name = "Name", Description = "Customer's name", GroupName = "Basic")]
    [Required(ErrorMessage = "Please enter the customer's name")]
    [StringLength(255)]
    public string Name { get;set; }

    [Display(Name = "Email", Description = "Customer's primary email address", GroupName = "Basic")]
    [Required]
    [StringLength(255)]
    [DataType(DataType.Email)]
    public string EmailAddress { get;set; }

    [Display(Name = "Last Order", Description = "The date when the customer last placed an order", GroupName = "Status")]
    public DateTime LastOrderPlaced { get;set; }

    [Display(Name = "Locked", Description = "Whether the customer account is locked", GroupName = "Status")]
    public bool IsLocked { get;set; }
}

我的视图看起来像这样：

@model Customer

<div class="edit-customer">
    @foreach (var property in ViewData.ModelMetadata.Properties.Where(p => !p.IsReadOnly).OrderBy(p => p.Order))
    {
        <div class="editor-row">
            @Html.DevExpress().Label(settings =>
                {
                    settings.AssociatedControlName = property.PropertyName;
                    settings.Text = property.DisplayName;
                    settings.ToolTip = property.Description;
                }).GetHtml()
            <span class="editor-field">
                @Html.DevExpress().TextBox(settings =>
                    {
                        settings.Name = property.PropertyName;
                        settings.Properties.NullText = property.Watermark;
                        settings.Width = 200;
                        settings.Properties.ValidationSettings.RequiredField.IsRequired = property.IsRequired;
                        settings.ShowModelErrors = true;
                    }).Bind(ViewData[property.PropertyName]).GetHtml()
            </span>
        </div>
    }
</div>

那么表单会根据元数据很好地布局，标签、工具提示、水印等都从模型的元数据中提取出来； 但是，我希望能够将这些项目分组在一起，例如在每个组的

中。有谁知道如何从元数据中获取 GroupName，而不需要为 ModelMetadata 编写扩展方法？

Answer 1

GroupName 不由 DataAnnotationsModelMetadataProvider 解析。因此，即使使用扩展方法，也无法直接从 ModelMetadata 对象中获取它。

您可以实现自己的提供程序，扩展现有提供程序以添加对 GroupName 的支持，Brad Wilson 在他的博客中进行了解释。

您还可以编写自己的属性，而不是使用 Display(GroupName = ) 并实现 IMetadataAware 接口，以将组名称添加到 ModelMetadata.AdditionalValues。

Answer 2

您还可以使用此扩展方法：

public static class ModelMetadataExtensions
{
  public static T GetPropertyAttribute<T>(this ModelMetadata instance)
    where T : Attribute
  {
    var result = instance.ContainerType
      .GetProperty(instance.PropertyName)
      .GetCustomAttributes(typeof(T), false)
      .Select(a => a as T)
      .FirstOrDefault(a => a != null);

    return result;
  } 
}

然后

var display= this.ViewData.ModelMetadata
  .GetPropertyAttribute<DisplayAttribute>();

var groupName = display.Groupname;

Answer 3

另一种方法是使用 ShortName< DisplayAttribute 类的 /code>属性。它由ModelMetadata类公开为ShortDisplayName 属性。

这并不完全是您想要的，但它可以让您避免创建另一个属性类...最重要的是，您可以利用 DisplayAttribute 的本地化能力。