.NET Framework Class Library
MetadataTypeAttribute Class

Updated: July 2008

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

Namespace:  System.ComponentModel.DataAnnotations
Assembly:  System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)
Syntax

Visual Basic (Declaration)
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := False, Inherited := False)> _
Public NotInheritable Class MetadataTypeAttribute _
    Inherits Attribute
Visual Basic (Usage)
Dim instance As MetadataTypeAttribute
C#
[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public sealed class MetadataTypeAttribute : Attribute
Visual C++
[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = false, Inherited = false)]
public ref class MetadataTypeAttribute sealed : public Attribute
JScript
public final class MetadataTypeAttribute extends Attribute
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.

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.

Visual Basic
Imports System
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

C#
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;


}

Inheritance Hierarchy

System..::.Object
  System..::.Attribute
    System.ComponentModel.DataAnnotations..::.MetadataTypeAttribute
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5 SP1
See Also

Reference

Change History

Date

History

Reason

July 2008

Added topic for new class.

SP1 feature change.

Tags :


Page view tracker