ServiceKnownTypeAttribute Classe

Définition

Espace de noms:

System.ServiceModel

Assembly:

System.ServiceModel.Primitives.dll

Paquet:

System.ServiceModel.Primitives v8.0.0

Source:

ServiceKnownTypeAttribute.cs

Spécifie les types connus utilisés par un service lors de la sérialisation ou de la désérialisation.

public ref class ServiceKnownTypeAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface | System.AttributeTargets.Method, AllowMultiple=true, Inherited=true)]
public sealed class ServiceKnownTypeAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface | System.AttributeTargets.Method, AllowMultiple=true, Inherited=true)>]
type ServiceKnownTypeAttribute = class
    inherit Attribute

Public NotInheritable Class ServiceKnownTypeAttribute
Inherits Attribute

Héritage

Object

Attribute

ServiceKnownTypeAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple suivant applique l’attribut ServiceKnownTypeAttribute à une interface où l’attribut spécifie un nom de méthode et un type déclarant.

// Define a service contract and apply the ServiceKnownTypeAttribute
// to specify types to include when generating client code.
// The types must have the DataContractAttribute and DataMemberAttribute
// applied to be serialized and deserialized. The attribute specifies the
// name of a method (GetKnownTypes) in a class (Helper) defined below.
[ServiceKnownType("GetKnownTypes", typeof(Helper))]
[ServiceContract()]
public interface ICatalog
{
    // Any object type can be inserted into a Hashtable. The
    // ServiceKnownTypeAttribute allows you to include those types
    // with the client code.
    [OperationContract]
    Hashtable GetItems();
}

// This class has the method named GetKnownTypes that returns a generic IEnumerable.
static class Helper
{
    public static IEnumerable<Type> GetKnownTypes(ICustomAttributeProvider provider)
    {
        System.Collections.Generic.List<System.Type> knownTypes =
            new System.Collections.Generic.List<System.Type>();
        // Add any types to include here.
        knownTypes.Add(typeof(Widget));
        knownTypes.Add(typeof(Machine));
        return knownTypes;
    }
}

[DataContract()]
public class Widget
{
    [DataMember]
    public string Id;
    [DataMember]
    public string Catalog;
}

[DataContract()]
public class Machine : Widget
{
    [DataMember]
    public string Maker;
}

' Define a service contract and apply the ServiceKnownTypeAttribute
' to specify types to include when generating client code. 
' The types must have the DataContractAttribute and DataMemberAttribute
' applied to be serialized and deserialized. The attribute specifies the 
' name of a method (GetKnownTypes) in a class (Helper) defined below.
<ServiceKnownType("GetKnownTypes", GetType(Helper)), ServiceContract()>  _
Public Interface ICalculator
    ' Any object type can be inserted into a Hashtable. The 
    ' ServiceKnownTypeAttribute allows you to include those types
    ' with the client code.
    <OperationContract()>  _
    Function GetItems() As Hashtable 
End Interface 

' This class has the method named GetKnownTypes that returns a generic IEnumerable.
Friend Class Helper
    Public Shared  Function GetKnownTypes(provider As ICustomAttributeProvider) _
     As IEnumerable(of Type) 
        Dim knownTypes As List(Of Type) = New List(Of Type)
        ' Add any types to include here.
        knownTypes.Add(GetType(Widget))
        knownTypes.Add(GetType(Machine))
        Return knownTypes
    End Function 
End Class 

<DataContract()>  _
Public Class Widget
    <DataMember()>  _
    Public Id As String
    <DataMember()>  _
    Public Catalog As String
End Class 

<DataContract()>  _
Public Class Machine
    Inherits Widget
    <DataMember()>  _
    Public Maker As String
End Class

Vous pouvez aussi appliquer l'attribut à l'interface spécifiant le type connu à inclure.

// Apply the ServiceKnownTypeAttribute to the
// interface specifying the type to include. Apply
// the attribute more than once if needed.
[ServiceKnownType(typeof(Widget))]
[ServiceKnownType(typeof(Machine))]
[ServiceContract()]
public interface ICatalog2
{
    // Any object type can be inserted into a Hashtable. The
    // ServiceKnownTypeAttribute allows you to include those types
    // with the client code.
    [OperationContract]
    Hashtable GetItems();
}

' Apply the ServiceKnownTypeAttribute to the 
' interface specifying the type to include. Apply the attribute
' more than once, if needed.
<ServiceKnownType(GetType(Widget)), ServiceKnownType(GetType(Machine)), _
 ServiceContract()>  _
Public Interface ICalculator2
    ' Any object type can be inserted into a Hashtable. The 
    ' ServiceKnownTypeAttribute allows you to include those types
    ' with the client code.
    <OperationContract()>  _
    Function GetItems() As Hashtable 
End Interface

Remarques

Le ServiceKnownTypeAttribute est destiné à être utilisé lors de la création de contrats de service Windows Communication Foundation (WCF) (interfaces qui définissent le service et ses méthodes). Les types connus sont des types qui peuvent être présents dans un graphique d’objets lorsque la sérialisation ou la désérialisation se produit. Pour plus d’informations sur les types connus, consultez Types connus de contrat de données.

Pour utiliser la MethodName propriété , créez une classe qui contient une méthode (ou des méthodes) qui retourne un tableau de types (chacun étant un type connu). Lors de l’application de l’attribut, définissez le methodName sur le nom d’une méthode qui retourne la liste des types et définissez sur declaringType le type qui contient la méthode. La méthode doit retourner un type qui implémente l’interface IEnumerable<T> . La méthode doit également inclure un paramètre de type ICustomAttributeProvider.

Vous pouvez également appliquer plusieurs fois l'attribut à une interface, une classe ou une méthode, en spécifiant à chaque fois un nouveau type connu.

Notes

Vous pouvez utiliser le mot ServiceKnownType dans votre Microsoft du code Visual Basic ou C# au lieu du plus longServiceKnownTypeAttribute.

Constructeurs

ServiceKnownTypeAttribute(String)	Initialise une nouvelle instance de la classe ServiceKnownTypeAttribute et spécifie le nom d'une méthode qui retourne les types connus.
ServiceKnownTypeAttribute(String, Type)	Initialise une nouvelle instance de la classe ServiceKnownTypeAttribute avec le nom d'une méthode qui retourne les types connus et le type qui contient la méthode (ou les méthodes) qui retourne les types connus.
ServiceKnownTypeAttribute(Type)	Initialise une nouvelle instance de la classe ServiceKnownTypeAttribute à l'aide du type connu spécifié.

Propriétés

DeclaringType	Obtient le type qui contient les méthodes qui retournent les types connus.
MethodName	Obtient le nom d'une méthode qui retourne la collection de types connus.
Type	Type connu qui peut être inclus dans un graphique d'objets.
TypeId	Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute. (Hérité de Attribute)

Méthodes

Equals(Object)	Retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
GetHashCode()	Retourne le code de hachage de cette instance. (Hérité de Attribute)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IsDefaultAttribute()	En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée. (Hérité de Attribute)
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Voir aussi

• DataContractAttribute
• DataMemberAttribute
• Types connus de contrats de données