ServiceKnownTypeAttribute Klasa

Definicja

Przestrzeń nazw:

System.ServiceModel

Zestaw:

System.ServiceModel.Primitives.dll

Pakiet:

System.ServiceModel.Primitives v8.0.0

Źródło:

ServiceKnownTypeAttribute.cs

Określa znane typy, które mają być używane przez usługę podczas serializacji lub deserializacji.

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

Dziedziczenie

Object

Attribute

ServiceKnownTypeAttribute

Atrybuty

AttributeUsageAttribute

Przykłady

Poniższy przykład stosuje ServiceKnownTypeAttribute atrybut do interfejsu, w którym atrybut określa nazwę metody i typ deklarujący.

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

Alternatywnie zastosuj atrybut do interfejsu określającego znany typ do uwzględnienia.

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

Uwagi

Jest ServiceKnownTypeAttribute przeznaczony do użycia podczas tworzenia kontraktów usług programu Windows Communication Foundation (WCF) (interfejsów definiujących usługę i jej metody). Znane typy to typy , które mogą być obecne na grafie obiektu podczas serializacji lub deserializacji. Aby uzyskać więcej informacji o znanych typach, zobacz Znane typy kontraktów danych.

Aby użyć MethodName właściwości, utwórz klasę zawierającą metodę (lub metody), która zwraca tablicę typów (każdy jest znanym typem). Podczas stosowania atrybutu ustaw methodName wartość na nazwę metody zwracającej listę typów i ustaw dla declaringType typu zawierającego metodę . Metoda musi zwrócić typ implementujący IEnumerable<T> interfejs. Metoda musi również zawierać parametr typu ICustomAttributeProvider.

Atrybut można również zastosować kilka razy do interfejsu, klasy lub metody przy każdym określeniu nowego znanego typu.

Uwaga

Możesz użyć słowa ServiceKnownType w kodzie Microsoft Visual Basic lub C# zamiast dłuższego ServiceKnownTypeAttribute.

Konstruktory

ServiceKnownTypeAttribute(String)	Inicjuje nowe wystąpienie ServiceKnownTypeAttribute klasy i określa nazwę metody zwracającej znane typy.
ServiceKnownTypeAttribute(String, Type)	Inicjuje nowe wystąpienie ServiceKnownTypeAttribute klasy o nazwie metody zwracającej znane typy i typ zawierający metodę (lub metody), która zwraca znane typy.
ServiceKnownTypeAttribute(Type)	Inicjuje ServiceKnownTypeAttribute nowe wystąpienie klasy o określonym znanym typie.

Właściwości

DeclaringType	Pobiera typ zawierający metody zwracające znane typy.
MethodName	Pobiera nazwę metody zwracającej kolekcję znanych typów.
Type	Znany typ, który można uwzględnić w grafie obiektu.
TypeId	Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego elementu Attribute. (Odziedziczone po Attribute)

Metody

Equals(Object)	Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi. (Odziedziczone po Attribute)
GetHashCode()	Zwraca wartość skrótu dla tego wystąpienia. (Odziedziczone po Attribute)
GetType()	Type Pobiera bieżące wystąpienie. (Odziedziczone po Object)
IsDefaultAttribute()	W przypadku zastąpienia w klasie pochodnej wskazuje, czy wartość tego wystąpienia jest wartością domyślną klasy pochodnej. (Odziedziczone po Attribute)
Match(Object)	W przypadku zastąpienia w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi. (Odziedziczone po Attribute)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)

Zobacz też

• DataContractAttribute
• DataMemberAttribute
• Znane typy kontraktów danych