CollectionDataContractAttribute クラス

定義

名前空間:

System.Runtime.Serialization

アセンブリ:

System.Runtime.Serialization.Primitives.dll

ソース:

CollectionDataContractAttribute.cs

コレクション型に適用すると、コレクション項目要素をカスタム指定できます。 この属性は、DataContractSerializer が有効なシリアル化可能コレクションとして認識する型に対してのみ適用できます。

public ref class CollectionDataContractAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=false)]
public sealed class CollectionDataContractAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct, AllowMultiple=false, Inherited=false)>]
type CollectionDataContractAttribute = class
    inherit Attribute

Public NotInheritable Class CollectionDataContractAttribute
Inherits Attribute

継承

Object

Attribute

CollectionDataContractAttribute

属性

AttributeUsageAttribute

例

CollectionDataContractAttribute クラスから継承するクラスに対して List<T> を適用する例を次に示します。 このコードは、Name プロパティと ItemName プロパティをカスタム値に設定します。

[CollectionDataContract(Name = "Custom{0}List", ItemName = "CustomItem")]
public class CustomList<T> : List<T>
{
    public CustomList()
        : base()
    {
    }

    public CustomList(T[] items)
        : base()
    {
        foreach (T item in items)
        {
            Add(item);
        }
    }
}

<CollectionDataContract(Name := "Custom{0}List", ItemName := "CustomItem")> _
Public Class CustomList(Of T)
    Inherits List(Of T)
    Public Sub New()
        MyBase.New()
    End Sub

    Public Sub New(ByVal items() As T)
        MyBase.New()
        For Each item As T In items
            Add(item)
        Next item
    End Sub
End Class

ServiceModel メタデータ ユーティリティ ツール (Svcutil.exe) を使用してクライアントのコードを生成する場合、コードは次の例のようになります。 クラスの名前と ItemName が違うことに注意してください。 ジェネリックを使用する場合は、型パラメーター名を使用して、結果の型名が作成されます。

// This is the generated code. Note that the class is renamed to "CustomBookList",
// and the ItemName is set to "CustomItem".
[System.CodeDom.Compiler.GeneratedCodeAttribute("System.Runtime.Serialization", "3.0.0.0")]
[System.Runtime.Serialization.CollectionDataContractAttribute(ItemName = "CustomItem")]
public class CustomBookList : System.Collections.Generic.List<Microsoft.Security.Samples.Book>
{
}

' This is the generated code. Note that the class is renamed to "CustomBookList", 
' and the ItemName is set to "CustomItem".
<System.CodeDom.Compiler.GeneratedCodeAttribute("System.Runtime.Serialization", "3.0.0.0"), System.Runtime.Serialization.CollectionDataContractAttribute(ItemName := "CustomItem")> _
Public Class CustomBookList
    Inherits System.Collections.Generic.List(Of Microsoft.Security.Samples.Book)
End Class

注釈

CollectionDataContractAttributeは、WCF 以外のプロバイダーからのデータを操作するときの相互運用性を容易にし、シリアル化されたインスタンスの正確な形状を制御することを目的としています。 この目的を達成するために、ItemName プロパティを使用して、コレクション内で繰り返される項目の名前を制御できます。 これは、プロバイダーが XML 要素型名を配列項目名として使用していない場合 (プロバイダーが XSD 型名 "string" の代わりに要素型名として "String" を使用している場合など) に特に役に立ちます。

CollectionDataContractAttribute には、ディクショナリ型と共に使用して、キー付きのコレクションを処理するという目的もあります。 ディクショナリ型は、IDictionary インターフェイスまたは IDictionary<TKey,TValue> インターフェイスのいずれか (例 : Dictionary<TKey,TValue>) を実装するクラスです。 KeyName プロパティと ValueName プロパティを使用して、Dictionary<TKey,TValue> クラスを使用するときのカスタム名を設定します。

の使用の詳細については、「データ コントラクトのDataContractSerializer使用」を参照してください。

コンストラクター

CollectionDataContractAttribute()

CollectionDataContractAttribute クラスの新しいインスタンスを初期化します。

プロパティ

IsItemNameSetExplicitly	ItemName が明示的に設定されているかどうかを取得します。
IsKeyNameSetExplicitly	KeyName が明示的に設定されているかどうかを取得します。
IsNameSetExplicitly	Name が明示的に設定されているかどうかを取得します。
IsNamespaceSetExplicitly	Namespace が明示的に設定されているかどうかを取得します。
IsReference	オブジェクト参照データを保持するかどうかを示す値を取得または設定します。
IsReferenceSetExplicitly	参照が明示的に設定されているかどうかを取得します。
IsValueNameSetExplicitly	ValueName が明示的に設定されているかどうかを取得します。
ItemName	コレクション要素のカスタム名を取得または設定します。
KeyName	ディクショナリ キー名のカスタム名を取得または設定します。
Name	コレクション型のデータ コントラクト名を取得または設定します。
Namespace	データ コントラクトの名前空間を取得または設定します。
TypeId	派生クラスで実装されると、この Attribute の一意の識別子を取得します。 (継承元 Attribute)
ValueName	ディクショナリ値名のカスタム名を取得または設定します。

メソッド

Equals(Object)	このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。 (継承元 Attribute)
GetHashCode()	このインスタンスのハッシュ コードを返します。 (継承元 Attribute)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
IsDefaultAttribute()	派生クラスでオーバーライドされるとき、このインスタンスの値が派生クラスの既定値であるかどうかを示します。 (継承元 Attribute)
Match(Object)	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (継承元 Attribute)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

こちらもご覧ください

• DataContractSerializer