ServiceKnownTypeAttribute Sınıf

Tanım

Ad Alanı:

System.ServiceModel

Bütünleştirilmiş Kod:

System.ServiceModel.Primitives.dll

Paket:

System.ServiceModel.Primitives v6.2.0

Source:

ServiceKnownTypeAttribute.cs

Seri hale getirildiğinde veya seri durumdan çıkarılırken bir hizmet tarafından kullanılacak bilinen türleri belirtir.

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

Devralma

Object

Attribute

ServiceKnownTypeAttribute

Öznitelikler

AttributeUsageAttribute

Örnekler

Aşağıdaki örnek, özniteliğinin ServiceKnownTypeAttribute bir yöntem adı ve bildirim türü belirttiği bir arabirime özniteliğini uygular.

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

Alternatif olarak, özniteliğini eklenecek bilinen türü belirten arabirime uygulayın.

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

Açıklamalar

, ServiceKnownTypeAttribute Windows Communication Foundation (WCF) hizmet sözleşmeleri (hizmeti ve yöntemlerini tanımlayan arabirimler) oluştururken kullanılmak üzere tasarlanmıştır. Bilinen türler, serileştirme veya seri durumdan çıkarma gerçekleştiğinde nesne grafında bulunabilecek türlerdir . Bilinen türler hakkında daha fazla bilgi için bkz. Veri Sözleşmesi Bilinen Türleri.

özelliğini kullanmak MethodName için, bir tür dizisi (her biri bilinen bir tür) döndüren bir yöntem (veya yöntemler) içeren bir sınıf oluşturun. özniteliğini uygularken, methodName türü listesini döndüren bir yöntemin adına ayarlayın ve öğesini yöntemini içeren türe ayarlayın declaringType . yöntemi arabirimini uygulayan IEnumerable<T> bir tür döndürmelidir. yöntemi, türünde ICustomAttributeProviderbir parametre de içermelidir.

Ayrıca özniteliğini bir arabirime, sınıfa veya yönteme her yeni bilinen tür belirttiğinizde birkaç kez uygulayabilirsiniz.

Not

sözcüğünü ServiceKnownType daha uzun ServiceKnownTypeAttributeyerine Microsoft Visual Basic veya C# kodunuzda kullanabilirsiniz.

Oluşturucular

ServiceKnownTypeAttribute(String)	sınıfının yeni bir örneğini ServiceKnownTypeAttribute başlatır ve bilinen türleri döndüren bir yöntemin adını belirtir.
ServiceKnownTypeAttribute(String, Type)	Bilinen türleri ve bilinen türleri döndüren yöntemi (veya yöntemleri) içeren türü döndüren bir yöntemin adıyla sınıfının yeni bir örneğini ServiceKnownTypeAttribute başlatır.
ServiceKnownTypeAttribute(Type)	Belirtilen bilinen türe sahip sınıfın ServiceKnownTypeAttribute yeni bir örneğini başlatır.

Özellikler

DeclaringType	Bilinen türleri döndüren yöntemleri içeren türü alır.
MethodName	Bilinen türlerin koleksiyonunu döndüren bir yöntemin adını alır.
Type	Nesne grafında yer alan bilinen tür.
TypeId	Türetilmiş bir sınıfta uygulandığında, bu Attributeiçin benzersiz bir tanımlayıcı alır. (Devralındığı yer: Attribute)

Yöntemler

Equals(Object)	Bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değeri döndürür. (Devralındığı yer: Attribute)
GetHashCode()	Bu örneğe ilişkin karma kodu döndürür. (Devralındığı yer: Attribute)
GetType()	Type Geçerli örneğini alır. (Devralındığı yer: Object)
IsDefaultAttribute()	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin değerinin türetilmiş sınıf için varsayılan değer olup olmadığını gösterir. (Devralındığı yer: Attribute)
Match(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin belirtilen bir nesneye eşit olup olmadığını belirten bir değer döndürür. (Devralındığı yer: Attribute)
MemberwiseClone()	Geçerli Objectöğesinin sığ bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden dizeyi döndürür. (Devralındığı yer: Object)

Ayrıca bkz.

• DataContractAttribute
• DataMemberAttribute
• Veri Sözleşmesi Bilinen Türler