web-dev-qa-db-ja.com

DisplayNameAttributeのローカライズ

PropertyGridに表示されるプロパティ名をローカライズする方法を探しています。プロパティの名前は、DisplayNameAttribute属性を使用して「上書き」できます。残念ながら、属性に非定数式を含めることはできません。したがって、次のような強く型付けされたリソースは使用できません。

class Foo
{
   [DisplayAttribute(Resources.MyPropertyNameLocalized)]  // do not compile
   string MyProperty {get; set;}
}

周りを見てみると、リソースを使用できるようにDisplayNameAttributeから継承する提案が見つかりました。私は次のようなコードになるでしょう:

class Foo
{
   [MyLocalizedDisplayAttribute("MyPropertyNameLocalized")] // not strongly typed
   string MyProperty {get; set;}
}

ただし、強く型付けされたリソースの利点は失われます。それから私は DisplayNameResourceAttribute に出会いました。これは私が探しているものかもしれません。しかし、Microsoft.VisualStudio.Modeling.Design名前空間にあるはずであり、この名前空間に追加する参照を見つけることができません。

DisplayNameのローカライズを良い方法で実現する簡単な方法があるかどうかは誰でも知っていますか?またはMicrosoftがVisual Studioに使用していると思われるものを使用する方法がありますか?

119
PowerKiKi

これが私が別のアセンブリ(私の場合は「共通」と呼ばれる)になった解決策です。

   [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Event)]
   public class DisplayNameLocalizedAttribute : DisplayNameAttribute
   {
      public DisplayNameLocalizedAttribute(Type resourceManagerProvider, string resourceKey)
         : base(Utils.LookupResource(resourceManagerProvider, resourceKey))
      {
      }
   }

リソースを検索するコードで:

  internal static string LookupResource(Type resourceManagerProvider, string resourceKey)
  {
     foreach (PropertyInfo staticProperty in  resourceManagerProvider.GetProperties(BindingFlags.Static | BindingFlags.NonPublic))
     {
        if (staticProperty.PropertyType == typeof(System.Resources.ResourceManager))
        {
           System.Resources.ResourceManager resourceManager = (System.Resources.ResourceManager)staticProperty.GetValue(null, null);
           return resourceManager.GetString(resourceKey);
        }
     }

     return resourceKey; // Fallback with the key name
  }

典型的な使用法は次のとおりです。

class Foo
{
      [Common.DisplayNameLocalized(typeof(Resources.Resource), "CreationDateDisplayName"),
      Common.DescriptionLocalized(typeof(Resources.Resource), "CreationDateDescription")]
      public DateTime CreationDate
      {
         get;
         set;
      }
}

リソースキーにリテラル文字列を使用しているので、かなりlyいのは何ですか。定数を使用すると、Resources.Designer.csを変更することになりますが、これはおそらく良い考えではありません。

結論:私はそれには満足していませんが、そのような一般的なタスクに役立つものを提供できないマイクロソフトについてはさらに不満です。

41
PowerKiKi

.NET 4のSystem.ComponentModel.DataAnnotationsから 表示属性 があります。MVC3 PropertyGridで動作します。

[Display(ResourceType = typeof(MyResources), Name = "UserName")]
public string UserName { get; set; }

これは、UserName .resxファイルでMyResourcesという名前のリソースを検索します。

111
RandomEngy

複数の言語をサポートするために、多くの属性に対してこれを行っています。 Microsoftに対しても同様のアプローチを取り、基本属性をオーバーライドして、実際の文字列ではなくリソース名を渡します。次に、リソース名を使用して、DLLリソースで実際の文字列が返されるように検索します。

例えば:

class LocalizedDisplayNameAttribute : DisplayNameAttribute
{
    private readonly string resourceName;
    public LocalizedDisplayNameAttribute(string resourceName)
        : base()
    {
      this.resourceName = resourceName;
    }

    public override string DisplayName
    {
        get
        {
            return Resources.ResourceManager.GetString(this.resourceName);
        }
    }
}

実際に属性を使用する場合、これをさらに一歩進めて、静的クラスのリソース名を定数として指定できます。そうすれば、次のような宣言が得られます。

[LocalizedDisplayName(ResourceStrings.MyPropertyName)]
public string MyProperty
{
  get
  {
    ...
  }
}

更新
ResourceStringsは次のようになります(各文字列は、実際の文字列を指定するリソースの名前を参照します)。

public static class ResourceStrings
{
    public const string ForegroundColorDisplayName="ForegroundColorDisplayName";
    public const string FontSizeDisplayName="FontSizeDisplayName";
}
79
Jeff Yates

C#6で Display 属性(System.ComponentModel.DataAnnotationsから)および nameof() 式を使用すると、ローカライズされた厳密に型指定されたソリューションが得られます。

[Display(ResourceType = typeof(MyResources), Name = nameof(MyResources.UserName))]
public string UserName { get; set; }
17
dionoid

T4を使用して定数を生成できます。私は1つ書いた:

<#@ template debug="false" hostspecific="true" language="C#" #>
<#@ output extension=".cs" #>
<#@ Assembly name="System.Xml.dll" #>
<#@ import namespace="System.Xml" #>
<#@ import namespace="System.Xml.XPath" #>
using System;
using System.ComponentModel;


namespace Bear.Client
{
 /// <summary>
 /// Localized display name attribute
 /// </summary>
 public class LocalizedDisplayNameAttribute : DisplayNameAttribute
 {
  readonly string _resourceName;

  /// <summary>
  /// Initializes a new instance of the <see cref="LocalizedDisplayNameAttribute"/> class.
  /// </summary>
  /// <param name="resourceName">Name of the resource.</param>
  public LocalizedDisplayNameAttribute(string resourceName)
   : base()
  {
   _resourceName = resourceName;
  }

  /// <summary>
  /// Gets the display name for a property, event, or public void method that takes no arguments stored in this attribute.
  /// </summary>
  /// <value></value>
  /// <returns>
  /// The display name.
  /// </returns>
  public override String DisplayName
  {
   get
   {
    return Resources.ResourceManager.GetString(this._resourceName);
   }
  }
 }

 partial class Constants
 {
  public partial class Resources
  {
  <# 
   var reader = XmlReader.Create(Host.ResolvePath("resources.resx"));
   var document = new XPathDocument(reader);
   var navigator = document.CreateNavigator();
   var dataNav = navigator.Select("/root/data");
   foreach (XPathNavigator item in dataNav)
   {
    var name = item.GetAttribute("name", String.Empty);
  #>
   public const String <#= name#> = "<#= name#>";
  <# } #>
  }
 }
}
14
zielu1

これは古い質問ですが、これは非常に一般的な問題だと思います。MVC3での私の解決策は次のとおりです。

まず、定数を生成して厄介な文字列を避けるために、T4テンプレートが必要です。すべてのラベル文字列を保持するリソースファイル「Labels.resx」があります。したがって、T4テンプレートはリソースファイルを直接使用し、

<#@ template debug="True" hostspecific="True" language="C#" #>
<#@ output extension=".cs" #>
<#@ Assembly Name="C:\Project\trunk\Resources\bin\Development\Resources.dll" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ import namespace="System.Collections" #>
<#@ import namespace="System.Globalization" #>
<#@ import namespace="System" #>
<#@ import namespace="System.Resources" #>
<#
  var resourceStrings = new List<string>();
  var manager = Resources.Labels.ResourceManager;

  IDictionaryEnumerator enumerator = manager.GetResourceSet(CultureInfo.CurrentCulture,  true, true)
                                             .GetEnumerator();
  while (enumerator.MoveNext())
  {
        resourceStrings.Add(enumerator.Key.ToString());
  }
#>     

// This file is generated automatically. Do NOT modify any content inside.

namespace Lib.Const{
        public static class LabelNames{
<#
            foreach (String label in resourceStrings){
#>                    
              public const string <#=label#> =     "<#=label#>";                    
<#
           }    
#>
    }
}

次に、「DisplayName」をローカライズする拡張メソッドが作成され、

using System.ComponentModel.DataAnnotations;
using Resources;

namespace Web.Extensions.ValidationAttributes
{
    public static class ValidationAttributeHelper
    {
        public static ValidationContext LocalizeDisplayName(this ValidationContext    context)
        {
            context.DisplayName = Labels.ResourceManager.GetString(context.DisplayName) ?? context.DisplayName;
            return context;
        }
    }
}

「Labels.resx」から自動的に読み取るために、「DisplayName」属性は「DisplayLabel」属性に置き換えられ、

namespace Web.Extensions.ValidationAttributes
{

    public class DisplayLabelAttribute :System.ComponentModel.DisplayNameAttribute
    {
        private readonly string _propertyLabel;

        public DisplayLabelAttribute(string propertyLabel)
        {
            _propertyLabel = propertyLabel;
        }

        public override string DisplayName
        {
            get
            {
                return _propertyLabel;
            }
        }
    }
}

これらの準備作業がすべて完了したら、これらのデフォルトの検証属性に触れます。例として「必須」属性を使用していますが、

using System.ComponentModel.DataAnnotations;
using Resources;

namespace Web.Extensions.ValidationAttributes
{
    public class RequiredAttribute : System.ComponentModel.DataAnnotations.RequiredAttribute
    {
        public RequiredAttribute()
        {
          ErrorMessageResourceType = typeof (Errors);
          ErrorMessageResourceName = "Required";
        }

        protected override ValidationResult IsValid(object value, ValidationContext  validationContext)
        {
            return base.IsValid(value, validationContext.LocalizeDisplayName());
        }

    }
}

これで、モデルにこれらの属性を適用できます。

using Web.Extensions.ValidationAttributes;

namespace Web.Areas.Foo.Models
{
    public class Person
    {
        [DisplayLabel(Lib.Const.LabelNames.HowOldAreYou)]
        public int Age { get; set; }

        [Required]
        public string Name { get; set; }
    }
}

デフォルトでは、プロパティ名は「Label.resx」を検索するためのキーとして使用されますが、「DisplayLabel」を使用して設定すると、代わりにそれが使用されます。

9
YYFish

メソッドの1つをオーバーライドすることにより、DisplayNameAttributeをサブクラス化してi18nを提供できます。そのようです。 編集:キーに定数を使用する必要があるかもしれません。

using System;
using System.ComponentModel;
using System.Windows.Forms;

class Foo {
    [MyDisplayName("bar")] // perhaps use a constant: SomeType.SomeResName
    public string Bar {get; set; }
}

public class MyDisplayNameAttribute : DisplayNameAttribute {
    public MyDisplayNameAttribute(string key) : base(Lookup(key)) {}

    static string Lookup(string key) {
        try {
            // get from your resx or whatever
            return "le bar";
        } catch {
            return key; // fallback
        }
    }
}

class Program {
    [STAThread]
    static void Main() {
        Application.Run(new Form { Controls = {
            new PropertyGrid { SelectedObject =
                new Foo { Bar = "abc" } } } });
    }
}
6
Marc Gravell

私はこの方法で解決します

[LocalizedDisplayName("Age", NameResourceType = typeof(RegistrationResources))]
 public bool Age { get; set; }

コードで

public sealed class LocalizedDisplayNameAttribute : DisplayNameAttribute
{
    private PropertyInfo _nameProperty;
    private Type _resourceType;


    public LocalizedDisplayNameAttribute(string displayNameKey)
        : base(displayNameKey)
    {

    }

    public Type NameResourceType
    {
        get
        {
            return _resourceType;
        }
        set
        {
            _resourceType = value;
            _nameProperty = _resourceType.GetProperty(base.DisplayName, BindingFlags.Static | BindingFlags.Public);
        }
    }

    public override string DisplayName
    {
        get
        {
            if (_nameProperty == null)
            {
                return base.DisplayName;
            }

            return (string)_nameProperty.GetValue(_nameProperty.DeclaringType, null);
        }
    }

}
2

さて、アセンブリはMicrosoft.VisualStudio.Modeling.Sdk.dll。 Visual Studio SDKに付属(Visual Studio Integration Packageを使用)。

ただし、属性とほぼ同じ方法で使用されます。属性が一定ではないという理由だけで、属性に厳密に型指定されたリソースを使用する方法はありません。

1
configurator

VB.NETコードをおforび申し上げます。C#が少し錆びています...

まず、LocalizedPropertyDescriptorを継承する新しいクラスPropertyDescriptorを作成します。次のようにDisplayNameプロパティをオーバーライドします。

Public Overrides ReadOnly Property DisplayName() As String
         Get
            Dim BaseValue As String = MyBase.DisplayName
            Dim Translated As String = Some.ResourceManager.GetString(BaseValue)
            If String.IsNullOrEmpty(Translated) Then
               Return MyBase.DisplayName
            Else
               Return Translated
           End If
    End Get
End Property

Some.ResourceManagerは、翻訳を含むリソースファイルのResourceManagerです。

次に、ローカライズされたプロパティを持つクラスにICustomTypeDescriptorを実装し、GetPropertiesメソッドをオーバーライドします。

Public Function GetProperties() As PropertyDescriptorCollection Implements System.ComponentModel.ICustomTypeDescriptor.GetProperties
    Dim baseProps As PropertyDescriptorCollection = TypeDescriptor.GetProperties(Me, True)
    Dim LocalizedProps As PropertyDescriptorCollection = New PropertyDescriptorCollection(Nothing)

    Dim oProp As PropertyDescriptor
    For Each oProp In baseProps
        LocalizedProps.Add(New LocalizedPropertyDescriptor(oProp))
    Next
    Return LocalizedProps
End Function

'DisplayName`属性を使用して、リソースファイルの値への参照を保存できるようになりました...

<DisplayName("prop_description")> _
Public Property Description() As String

prop_descriptionはリソースファイルのキーです。