方法: メタデータクラスを追加する

[アーティクル]
03/11/2011

ここでは、エンティティの動作に影響を与える属性によってメタデータクラス内のプロパティを装飾することで、メタデータを使用してサーバーおよびクライアント側のエンティティに機能を追加する方法について説明します。WCF RIA サービスでは、エンティティクラスおよびプロパティに注釈を付ける機能がサポートされています。注釈は、メタデータクラスと呼ばれる部分クラスで実装されます。生成されたエンティティクラスに注釈を付け、エンティティクラスを再生成してもその注釈が失われないようにする場合にメタデータクラスを使用します。これにより、検証や子エンティティコンポジションなどの機能を追加できます。メタデータクラスを指定するには、MetadataTypeAttribute 属性を使用します。

メタデータクラスを追加する方法は 2 とおりあります。新しいドメインサービスクラスを追加ウィザードを使用して新しい DomainService クラスを追加する場合は、[メタデータ用の関連クラスを生成する] チェックボックスをオンにすることで、メタデータクラスが自動的に生成されるように指定できます。また、メタデータクラスを手動で追加することもできます。ここでは、メタデータクラスを追加するこの 2 つの方法について説明します。

DomainService クラステンプレートを使用してメタデータクラスを追加するには

サーバープロジェクトで、新しい項目を追加し、[DomainService クラス] テンプレートをクリックします。
[新しいドメインサービスクラスの追加] ダイアログボックスが表示されたら、ドメインサービスで公開するエンティティを選択します。
[メタデータ用の関連クラスを生成する] チェックボックスをオンにします。
[OK] をクリックします。

ドメインサービスクラス用のファイルが生成され、メタデータクラス用のファイルが生成されます。このメタデータクラスの名前には、.metadata が含まれています (DomainService1.metadata.cs、DomainService1.metadata.vb など)。

メタデータクラスを開き、プロパティに属性を追加します。

RoundtripOriginalAttribute、RequiredAttribute、StringLengthAttribute、および ExcludeAttribute を一部のプロパティに適用したメタデータクラスを次の例に示します。

<MetadataTypeAttribute(GetType(Address.AddressMetadata))>  _
Partial Public Class Address

    Friend NotInheritable Class AddressMetadata

        'Metadata classes are not meant to be instantiated.
        Private Sub New()
            MyBase.New
        End Sub

        Public AddressID As Integer

        <Required()> _
        <StringLength(60)> _
        <RoundtripOriginal()> _
        Public AddressLine1 As String

        <RoundtripOriginal()> _
        Public AddressLine2 As String

        <Required()> _
        <StringLength(30)> _
        <RoundtripOriginal()> _
        Public City As String

        <RoundtripOriginal()> _
        Public CountryRegion As String

        Public CustomerAddresses As EntityCollection(Of CustomerAddress)

        <RoundtripOriginal()> _
        Public ModifiedDate As DateTime

        <Required()> _
        <RoundtripOriginal()> _
        Public PostalCode As String

        <Exclude()> _
        Public rowguid As Guid

        <RoundtripOriginal()> _
        Public StateProvince As String
    End Class
End Class

[MetadataTypeAttribute(typeof(Address.AddressMetadata))]
public partial class Address
{

    internal sealed class AddressMetadata
    {
        // Metadata classes are not meant to be instantiated.
        private AddressMetadata()
        {
        }

        public int AddressID { get; set; }

        [Required]
        [StringLength(60)]
        [RoundtripOriginal]
        public string AddressLine1 { get; set; }

        [RoundtripOriginal]
        public string AddressLine2 { get; set; }

        [Required]
        [StringLength(30)]
        [RoundtripOriginal]
        public string City { get; set; }

        [RoundtripOriginal]
        public string CountryRegion { get; set; }

        public EntityCollection<CustomerAddress> CustomerAddresses { get; set; }

        [RoundtripOriginal]
        public DateTime ModifiedDate { get; set; }

        [Required]
        [RoundtripOriginal]
        public string PostalCode { get; set; }

        [Exclude]
        public Guid rowguid { get; set; }

        [RoundtripOriginal]
        public string StateProvince { get; set; }
    }
}

メタデータクラスを手動で追加するには

サーバープロジェクトで、注釈を付けるエンティティクラスと同じ名前の新しいクラスファイルを追加します。規則として、ファイル名に .metadata を含めます。
partial キーワードを追加して、このクラスを部分クラスにします。

Address という名前のエンティティクラスに一致する部分クラスを次の例に示します。
```
Partial Public Class Address
End Class
```
```
public partial class Address
{
}
```

部分クラスで、メタデータクラスとして機能する内部クラスを作成します。

内部メタデータクラスを次の例に示します。

Partial Public Class Address
  Friend NotInheritable Class AddressMetadata
  End Class
End Class

public partial class Address
{
  internal sealed class AddressMetadata
  {
  }
}

MetadataTypeAttribute 属性を部分クラスに追加し、メタデータクラスの型を含めます。

クラスに適用された MetadataTypeAttribute 属性を次の例に示します。

<MetadataTypeAttribute(GetType(Address.AddressMetadata))> _
Partial Public Class Address
  Friend NotInheritable Class AddressMetadata
  End Class
End Class

[MetadataTypeAttribute(typeof(Address.AddressMetadata))]
public partial class Address
{
  internal sealed class AddressMetadata
  {
  }
}

メタデータクラスで、エンティティクラス内のプロパティと同じ名前のプロパティを追加します。

プロパティに属性を追加します。

RoundtripOriginalAttribute、RequiredAttribute、StringLengthAttribute、および ExcludeAttribute を一部のプロパティに適用したメタデータクラスを次の例に示します。

<MetadataTypeAttribute(GetType(Address.AddressMetadata))>  _
Partial Public Class Address

    Friend NotInheritable Class AddressMetadata

        'Metadata classes are not meant to be instantiated.
        Private Sub New()
            MyBase.New
        End Sub

        Public AddressID As Integer

        <Required()> _
        <StringLength(60)> _
        <RoundtripOriginal()> _
        Public AddressLine1 As String

        <RoundtripOriginal()> _
        Public AddressLine2 As String

        <Required()> _
        <StringLength(30)> _
        <RoundtripOriginal()> _
        Public City As String

        <RoundtripOriginal()> _
        Public CountryRegion As String

        Public CustomerAddresses As EntityCollection(Of CustomerAddress)

        <RoundtripOriginal()> _
        Public ModifiedDate As DateTime

        <Required()> _
        <RoundtripOriginal()> _
        Public PostalCode As String

        <Exclude()> _
        Public rowguid As Guid

        <RoundtripOriginal()> _
        Public StateProvince As String
    End Class
End Class

[MetadataTypeAttribute(typeof(Address.AddressMetadata))]
public partial class Address
{

    internal sealed class AddressMetadata
    {
        // Metadata classes are not meant to be instantiated.
        private AddressMetadata()
        {
        }

        public int AddressID { get; set; }

        [Required]
        [StringLength(60)]
        [RoundtripOriginal]
        public string AddressLine1 { get; set; }

        [RoundtripOriginal]
        public string AddressLine2 { get; set; }

        [Required]
        [StringLength(30)]
        [RoundtripOriginal]
        public string City { get; set; }

        [RoundtripOriginal]
        public string CountryRegion { get; set; }

        public EntityCollection<CustomerAddress> CustomerAddresses { get; set; }

        [RoundtripOriginal]
        public DateTime ModifiedDate { get; set; }

        [Required]
        [RoundtripOriginal]
        public string PostalCode { get; set; }

        [Exclude]
        public Guid rowguid { get; set; }

        [RoundtripOriginal]
        public string StateProvince { get; set; }
    }
}

次の方法で共有

方法: メタデータクラスを追加する

DomainService クラステンプレートを使用してメタデータクラスを追加するには

メタデータクラスを手動で追加するには

その他のリソース

次の方法で共有

方法: メタデータ クラスを追加する

DomainService クラス テンプレートを使用してメタデータ クラスを追加するには

メタデータ クラスを手動で追加するには

その他のリソース

方法: メタデータクラスを追加する

DomainService クラステンプレートを使用してメタデータクラスを追加するには

メタデータクラスを手動で追加するには