ServiceKnownTypeAttribute Constructors

Definition

Namespace:

System.ServiceModel

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.0.0

Initializes a new instance of the ServiceKnownTypeAttribute class.

Overloads

ServiceKnownTypeAttribute(String)	Initializes a new instance of the ServiceKnownTypeAttribute class and specifies the name of a method that returns the known types.
ServiceKnownTypeAttribute(Type)	Initializes a new instance of the ServiceKnownTypeAttribute class with the specified known type.
ServiceKnownTypeAttribute(String, Type)	Initializes a new instance of the ServiceKnownTypeAttribute class with the name of a method that returns the known types and the type that contains the method (or methods) that returns the known types.

ServiceKnownTypeAttribute(String)

Source:

ServiceKnownTypeAttribute.cs

Initializes a new instance of the ServiceKnownTypeAttribute class and specifies the name of a method that returns the known types.

public:
 ServiceKnownTypeAttribute(System::String ^ methodName);

public ServiceKnownTypeAttribute (string methodName);

new System.ServiceModel.ServiceKnownTypeAttribute : string -> System.ServiceModel.ServiceKnownTypeAttribute

Public Sub New (methodName As String)

Parameters

methodName

String

The name of a method that returns the known types.

Remarks

Use this constructor when applying the ServiceKnownTypeAttribute to a class that contains methods that return known types.

See also

• DeclaringType
• MethodName

ServiceKnownTypeAttribute(Type)

Source:

ServiceKnownTypeAttribute.cs

Initializes a new instance of the ServiceKnownTypeAttribute class with the specified known type.

public:
 ServiceKnownTypeAttribute(Type ^ type);

public ServiceKnownTypeAttribute (Type type);

new System.ServiceModel.ServiceKnownTypeAttribute : Type -> System.ServiceModel.ServiceKnownTypeAttribute

Public Sub New (type As Type)

Parameters

type

Type

Specifies a known type that can be used in a parameter or return value defined by the service.

Examples

The following example applies the ServiceKnownTypeAttribute attribute to an interface where the attribute specifies the type to include.

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

Remarks

The ServiceKnownTypeAttribute can be applied several times to a method, with each application naming a different known type that may be present in the object graph returned by the method.

ServiceKnownTypeAttribute(String, Type)

Source:

ServiceKnownTypeAttribute.cs

Initializes a new instance of the ServiceKnownTypeAttribute class with the name of a method that returns the known types and the type that contains the method (or methods) that returns the known types.

public:
 ServiceKnownTypeAttribute(System::String ^ methodName, Type ^ declaringType);

public ServiceKnownTypeAttribute (string methodName, Type declaringType);

new System.ServiceModel.ServiceKnownTypeAttribute : string * Type -> System.ServiceModel.ServiceKnownTypeAttribute

Public Sub New (methodName As String, declaringType As Type)

Parameters

methodName

String

The name of a method that returns the known types.

declaringType

Type

The type that can use the known types in its object graph.

Examples

The following example applies the ServiceKnownTypeAttribute attribute to an interface where the attribute specifies a method name and a declaring type.

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

See also

• DeclaringType
• MethodName