c# - Is it possible to add an attribute to a property in a partial class?

Question

I don't think it's possible but since I haven't got a definite clarity from MSDN, I feel that it's best to ask. Suppose that we have a class as follows.

public partial class Hazaa
{
  public int Shazoo { get; set; }
}

Then, I'd like Shazoo to be attributed as SuperCool but I wish to do so in another file. Since I'm using partial classes, I can add new properties as follows.

public partial class Hazaa
{
  [SuperCool]
  public int Wheee { get; set; }
}

But can I attribute a property declared in the first sample by writing code in the latter? I doubt it's possible but I'll be glad to stand corrected. If so, what's the syntax?

Answer 1

Based on your requirements, as an option you can consider using:

• MetadataType attribute

Note: The attributes that you can register this way are not really your class attributes, but most frameworks like ASP.NET MVC use them like your class native attributes.

If you want to add data annotations attributes, specially in as ASP.NET MVC project, you will find this way helpful.

Also for other frameworks like Windows Forms that don't support MetadataTypeAttribute you can simply add support using AssociatedMetadataTypeTypeDescriptionProvider.

The solution is not restricted to data annotations attributes and you can use all kind of attributes that are meaningful for your libraries and frameworks.

How to define additional attributes?

You can create a metadata class that contains properties of your original class decorated by suitable attributes and then decorate the partial class by MetadataType attribute and introduce the metadata class for your original class.

How to see the impact of those attributes?

Frameworks like ASP.NET MVC use those attributes like they are defined in your original class.

Also You can register AssociatedMetadataTypeTypeDescriptionProvider as provider for your original type for other frameworks or components that may want to use TypeDescriptor to get information about your type.

Are they really my class attributes?

Please pay attention, this way, the attributes really don't belong to your original class, but for most frameworks, like ASP.NET MVC or Windows Forms that use TypeDescriptor to get information about types, they act like your class original attributes.

So if you want to get attributes for a property using reflection, you can't see them, but if you you use TypeDescriptor mechanism, you can see them.

An Example

Hazaa Class:

public partial class Hazaa
{
    public int Shazoo { get; set; }
}

HazaaMetadata Class

[MetadataType(typeof(HazaaMetadata))]
public partial class Hazaa
{
}

public class HazaaMetadata
{
    [DisplayName("Shazoo Name")]
    public int Shazoo { get; set; }
}

ASP.NET MVC Usage

you don't need to do anything else to make that DisplayName work, you can simply use Html.Labelfor or Html.DisplayNameFor to see the impact. It will show "Shazoo Name" as label text.

Windows Forms Usage

Some where in your application (like form load, main, ...) register the provider this way:

var provider = new AssociatedMetadataTypeTypeDescriptionProvider(typeof(Hazaa));
TypeDescriptor.AddProvider(provider, typeof(Hazaa));

And as a result, you will see PropertyGrid and DataGridView use "Shazoo Name" as caption for property and column title.