MetadataTypeAttribute Class

Definition

Namespace:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.Annotations.dll

Source:

MetadataTypeAttribute.cs

Specifies the metadata class to associate with a data model class.

public ref class MetadataTypeAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false)]
public sealed class MetadataTypeAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false)>]
type MetadataTypeAttribute = class
    inherit Attribute

Public NotInheritable Class MetadataTypeAttribute
Inherits Attribute

Inheritance

Object

Attribute

MetadataTypeAttribute

Attributes

AttributeUsageAttribute

Examples

The following example shows how to use the MetadataTypeAttribute to associate a metadata class with an entity partial class. The example applies the RequiredAttribute attribute to a data field to show how to provide additional information in the associated metadata class.

using System;
using System.Web.DynamicData;
using System.ComponentModel.DataAnnotations;

[MetadataType(typeof(CustomerMetaData))]
public partial class Customer
{
}


public class CustomerMetaData
{
    // Apply RequiredAttribute
    [Required(ErrorMessage = "Title is required.")]
    public object Title;
}

Imports System.Web.DynamicData
Imports System.ComponentModel.DataAnnotations

<MetadataType(GetType(CustomerMetadata))> _
Partial Public Class Customer

End Class

Public Class CustomerMetadata

    ' Apply RequitedAttribute.
    <Required(ErrorMessage:="Title is required.")> _
    Public Title As Object

   
End Class

Remarks

The MetadataTypeAttribute attribute enables you to associate a class with a data-model partial class. In this associated class you provide additional metadata information that is not in the data model.

For example, in the associated class you can apply the RequiredAttribute attribute to a data field. This enforces that a value is provided for the field even if this constraint is not required by the database schema.

You use the MetadataTypeAttribute attribute as follows:

• In your application, create a file in which you create the data-model partial class that you want to modify.

• Create the associated metadata class.

• Apply the MetadataTypeAttribute attribute to the partial entity class, specifying the associated class.

When you apply this attribute, you must adhere to the following usage constraints:

• The attribute can only be applied to a class.

• The attribute cannot be inherited by derived classes.

• The attribute can be applied only one time.

Constructors

MetadataTypeAttribute(Type)

Initializes a new instance of the MetadataTypeAttribute class.

Properties

MetadataClassType	Gets the metadata class that is associated with a data-model partial class.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)