ServiceKnownTypeAttribute Classe

Definizione

Spazio dei nomi:

System.ServiceModel

Assembly:

System.ServiceModel.Primitives.dll

Pacchetto:

System.ServiceModel.Primitives v8.0.0

Origine:

ServiceKnownTypeAttribute.cs

Consente di specificare i tipi conosciuti utilizzati da un servizio durante la serializzazione o la deserializzazione.

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

Ereditarietà

Object

Attribute

ServiceKnownTypeAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio seguente viene applicato l'attributo a un'interfaccia ServiceKnownTypeAttribute in cui l'attributo specifica un nome di metodo e un tipo dichiarante.

// 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

In alternativa, l'attributo può essere applicato all'interfaccia in modo da specificare il tipo conosciuto da includere.

// 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

Commenti

l'oggetto ServiceKnownTypeAttribute è destinato all'uso durante la creazione di contratti di servizio di Windows Communication Foundation (WCF) (interfacce che definiscono il servizio e i relativi metodi). I tipi noti sono tipi che possono essere presenti in un oggetto grafico quando si verifica la serializzazione o la deserializzazione. Per altre informazioni sui tipi noti, vedere Tipi noti del contratto dati.

Per usare la MethodName proprietà , creare una classe che contiene un metodo (o metodi) che restituisce una matrice di tipi (ognuno di essi è un tipo noto). Quando si applica l'attributo, impostare l'oggetto methodName sul nome di un metodo che restituisce l'elenco di tipi e impostare l'oggetto declaringType sul tipo che contiene il metodo . Il metodo deve restituire un tipo che implementa l'interfaccia IEnumerable<T> . Il metodo deve includere anche un parametro di tipo ICustomAttributeProvider.

L'attributo può anche essere applicato più volte a un'interfaccia, a una classe o a un metodo, specificando ogni volta un nuovo tipo conosciuto.

Nota

È possibile usare la parola ServiceKnownType nel codice Microsoft Visual Basic o C# anziché nel formato più lungoServiceKnownTypeAttribute.

Costruttori

ServiceKnownTypeAttribute(String)	Inizializza una nuova istanza della classe ServiceKnownTypeAttribute e specifica il nome di un metodo che restituisce i tipi conosciuti.
ServiceKnownTypeAttribute(String, Type)	Consente di inizializzare una nuova istanza della classe ServiceKnownTypeAttribute con il nome di un metodo e con il tipo contenente i metodi che restituiscono i tipi conosciuti.
ServiceKnownTypeAttribute(Type)	Consente di inizializzare una nuova istanza della classe ServiceKnownTypeAttribute con il tipo conosciuto specificato.

Proprietà

DeclaringType	Consente di ottenere il tipo contenente i metodi che restituiscono i tipi conosciuti.
MethodName	Consente di ottenere il nome di un metodo che restituisce la raccolta di tipi conosciuti.
Type	Tipo conosciuto che può essere incluso in un oggetto grafico.
TypeId	Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute. (Ereditato da Attribute)

Metodi

Equals(Object)	Restituisce un valore che indica se questa istanza è uguale a un oggetto specificato. (Ereditato da Attribute)
GetHashCode()	Restituisce il codice hash per l'istanza. (Ereditato da Attribute)
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
IsDefaultAttribute()	In caso di override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata. (Ereditato da Attribute)
Match(Object)	Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato. (Ereditato da Attribute)
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)

Vedi anche

• DataContractAttribute
• DataMemberAttribute
• Tipi conosciuti di contratto dati