GenericTypeParameterBuilder.SetInterfaceConstraints Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Sets the interfaces a type must implement in order to be substituted for the type parameter.

Namespace:  System.Reflection.Emit
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
<ComVisibleAttribute(True)> _
Public Sub SetInterfaceConstraints ( _
    ParamArray interfaceConstraints As Type() _
)

[ComVisibleAttribute(true)]
public void SetInterfaceConstraints(
    params Type[] interfaceConstraints
)

Parameters

• interfaceConstraints
  Type: array<System.Type[]
  An array of Type objects that represent the interfaces a type must implement in order to be substituted for the type parameter.

Remarks

Interface constraints cannot be retrieved using methods of the GenericTypeParameterBuilder class. Once you have created the generic type that contains the type parameter, you can use its Type object to reflect the type parameters and their constraints. To get the type parameters of a completed generic type, use the Type.GetGenericArguments method. For each type parameter, get the base type constraint and interface constraints by using the Type.GetGenericParameterConstraints method.

Examples

The following code example creates a generic type with two type parameters, the second of which has two interface constraints. For a more detailed explanation of the steps involved in defining a dynamic generic type, see How to: Define a Generic Type with Reflection Emit.

Imports System.Reflection
Imports System.Reflection.Emit
Imports System.Collections.Generic

' Define a trivial base class and two trivial interfaces 
' to use when demonstrating constraints.
'
Public Class ExampleBase
End Class

Public Interface IExampleA
End Interface

Public Interface IExampleB
End Interface

' Define a trivial type that can substitute for type parameter 
' TSecond.
'
Public Class ExampleDerived
   Inherits ExampleBase
   Implements IExampleA, IExampleB
End Class

Public Class Example

   ' Make the output TextBlock available to all methods.
   Private Shared outputBlock As System.Windows.Controls.TextBlock

   Public Shared Sub Demo(ByVal output As System.Windows.Controls.TextBlock)

      outputBlock = output

      ' Define a dynamic assembly to contain the sample type. In Silverlight, 
      ' a dynamic assembly has only one module. 
      '
      Dim myDomain As AppDomain = AppDomain.CurrentDomain
      Dim myAsmName As New AssemblyName("GenericEmitExample1")
      Dim myAssembly As AssemblyBuilder = myDomain.DefineDynamicAssembly( _
          myAsmName, _
          AssemblyBuilderAccess.Run)
      Dim myModule As ModuleBuilder = myAssembly.DefineDynamicModule( _
          myAsmName.Name)

      ' Get type objects for the base class trivial interfaces to
      ' be used as constraints.
      '
      Dim baseType As Type = GetType(ExampleBase)
      Dim interfaceA As Type = GetType(IExampleA)
      Dim interfaceB As Type = GetType(IExampleB)

      ' Define the sample type.
      '
      Dim myType As TypeBuilder = myModule.DefineType( _
          "Sample", _
          TypeAttributes.Public)

      outputBlock.Text &= String.Format("Type 'Sample' is generic: {0}", _
          myType.IsGenericType) & vbCrLf

      ' Define type parameters for the type. Until you do this, 
      ' the type is not generic, as the preceding and following 
      ' WriteLine statements show. The type parameter names are
      ' specified as an array of strings. To make the code
      ' easier to read, each GenericTypeParameterBuilder is placed
      ' in a variable with the same name as the type parameter.
      ' 
      Dim typeParamNames() As String = {"TFirst", "TSecond"}
      Dim typeParams() As GenericTypeParameterBuilder = _
          myType.DefineGenericParameters(typeParamNames)

      Dim TFirst As GenericTypeParameterBuilder = typeParams(0)
      Dim TSecond As GenericTypeParameterBuilder = typeParams(1)

      outputBlock.Text &= String.Format("Type 'Sample' is generic: {0}", _
          myType.IsGenericType) & vbCrLf

      ' Apply constraints to the type parameters.
      '
      ' A type that is substituted for the first parameter, TFirst,
      ' must be a reference type and must have a parameterless
      ' constructor.
      TFirst.SetGenericParameterAttributes( _
          GenericParameterAttributes.DefaultConstructorConstraint _
          Or GenericParameterAttributes.ReferenceTypeConstraint)

      ' A type that is substituted for the second type
      ' parameter must implement IExampleA and IExampleB, and
      ' inherit from the trivial test class ExampleBase. The
      ' interface constraints are specified as an array 
      ' containing the interface types.
      TSecond.SetBaseTypeConstraint(baseType)
      Dim interfaceTypes() As Type = {interfaceA, interfaceB}
      TSecond.SetInterfaceConstraints(interfaceTypes)

      ' The following code adds a private field named ExampleField,
      ' of type TFirst.
      Dim exField As FieldBuilder = _
          myType.DefineField("ExampleField", TFirst, _
              FieldAttributes.Private)

      ' Define a Shared method that takes an array of TFirst and 
      ' returns a List(Of TFirst) containing all the elements of 
      ' the array. To define this method it is necessary to create
      ' the type List(Of TFirst) by calling MakeGenericType on the
      ' generic type definition, List(Of T). (The T is omitted with
      ' the GetType operator when you get the generic type 
      ' definition.) The parameter type is created by using the
      ' MakeArrayType method. 
      '
      Dim listOf As Type = GetType(List(Of ))
      Dim listOfTFirst As Type = listOf.MakeGenericType(TFirst)
      Dim mParamTypes() As Type = {TFirst.MakeArrayType()}

      Dim exMethod As MethodBuilder = _
          myType.DefineMethod("ExampleMethod", _
              MethodAttributes.Public Or MethodAttributes.Static, _
              listOfTFirst, _
              mParamTypes)

      ' Emit the method body. 
      ' The method body consists of just three opcodes, to load 
      ' the input array onto the execution stack, to call the 
      ' List(Of TFirst) constructor that takes IEnumerable(Of TFirst),
      ' which does all the work of putting the input elements into
      ' the list, and to return, leaving the list on the stack. The
      ' hard work is getting the constructor.
      ' 
      ' The GetConstructor method is not supported on a 
      ' GenericTypeParameterBuilder, so it is not possible to get 
      ' the constructor of List(Of TFirst) directly. There are two
      ' steps, first getting the constructor of List(Of T) and then
      ' calling a method that converts it to the corresponding 
      ' constructor of List(Of TFirst).
      '
      ' The constructor needed here is the one that takes an
      ' IEnumerable(Of T). Note, however, that this is not the 
      ' generic type definition of IEnumerable(Of T); instead, the
      ' T from List(Of T) must be substituted for the T of 
      ' IEnumerable(Of T). (This seems confusing only because both
      ' types have type parameters named T. That is why this example
      ' uses the somewhat silly names TFirst and TSecond.) To get
      ' the type of the constructor argument, take the generic
      ' type definition IEnumerable(Of T) (expressed as 
      ' IEnumerable(Of ) when you use the GetType operator) and 
      ' call MakeGenericType with the first generic type parameter
      ' of List(Of T). The constructor argument list must be passed
      ' as an array, with just one argument in this case.
      ' 
      ' Now it is possible to get the constructor of List(Of T),
      ' using GetConstructor on the generic type definition. To get
      ' the constructor of List(Of TFirst), pass List(Of TFirst) and
      ' the constructor from List(Of T) to the static
      ' TypeBuilder.GetConstructor method.
      '
      Dim ilgen As ILGenerator = exMethod.GetILGenerator()

      Dim ienumOf As Type = GetType(IEnumerable(Of ))
      Dim listOfTParams() As Type = listOf.GetGenericArguments()
      Dim TfromListOf As Type = listOfTParams(0)
      Dim ienumOfT As Type = ienumOf.MakeGenericType(TfromListOf)
      Dim ctorArgs() As Type = {ienumOfT}

      Dim ctorPrep As ConstructorInfo = _
          listOf.GetConstructor(ctorArgs)
      Dim ctor As ConstructorInfo = _
          TypeBuilder.GetConstructor(listOfTFirst, ctorPrep)

      ilgen.Emit(OpCodes.Ldarg_0)
      ilgen.Emit(OpCodes.Newobj, ctor)
      ilgen.Emit(OpCodes.Ret)

      ' Create the type. 
      Dim finished As Type = myType.CreateType()

      ' Invoke the method.
      ' ExampleMethod is not generic, but the type it belongs to is
      ' generic, so in order to get a MethodInfo that can be invoked
      ' it is necessary to create a constructed type. The Example 
      ' class satisfies the constraints on TFirst, because it is a 
      ' reference type and has a default constructor. In order to
      ' have a class that satisfies the constraints on TSecond, 
      ' this code example defines the ExampleDerived type. These
      ' two types are passed to MakeGenericMethod to create the
      ' constructed type.
      '
      Dim typeArgs() As Type = _
          {GetType(Example), GetType(ExampleDerived)}
      Dim constructed As Type = finished.MakeGenericType(typeArgs)
      Dim mi As MethodInfo = constructed.GetMethod("ExampleMethod")

      ' Create an array of Example objects, as input to the generic
      ' method. This array must be passed as the only element of an 
      ' array of arguments. The first argument of Invoke is 
      ' Nothing, because ExampleMethod is Shared. Display the count
      ' on the resulting List(Of Example).
      ' 
      Dim input() As Example = {New Example(), New Example()}
      Dim arguments() As Object = {input}

      Dim listX As List(Of Example) = mi.Invoke(Nothing, arguments)

      outputBlock.Text &= String.Format(vbLf & _
          "There are {0} elements in the List(Of Example).", _
          listX.Count _
      ) & vbCrLf

      DisplayGenericParameters(finished)

   End Sub


   Private Shared Sub DisplayGenericParameters(ByVal t As Type)

      If Not t.IsGenericType Then
         outputBlock.Text &= String.Format("Type '{0}' is not generic.") & vbCrLf
         Return
      End If
      If Not t.IsGenericTypeDefinition Then _
          t = t.GetGenericTypeDefinition()

      Dim typeParameters() As Type = t.GetGenericArguments()
      outputBlock.Text &= String.Format(vbCrLf & _
          "Listing {0} type parameters for type '{1}'.", _
          typeParameters.Length, t) & vbCrLf

      For Each tParam As Type In typeParameters

         outputBlock.Text &= String.Format(vbCrLf & "Type parameter {0}:", _
             tParam.ToString()) & vbCrLf

         For Each c As Type In tParam.GetGenericParameterConstraints()
            If c.IsInterface Then
               outputBlock.Text &= String.Format("    Interface constraint: {0}", c) & vbCrLf
            Else
               outputBlock.Text &= String.Format("    Base type constraint: {0}", c) & vbCrLf
            End If
         Next

         ListConstraintAttributes(tParam)
      Next tParam
   End Sub


   ' List the constraint flags. The GenericParameterAttributes
   ' enumeration contains two sets of attributes, variance and
   ' constraints. For this example, only constraints are used.
   '
   Private Shared Sub ListConstraintAttributes(ByVal t As Type)

      ' Mask off the constraint flags. 
      Dim constraints As GenericParameterAttributes = _
          t.GenericParameterAttributes And _
          GenericParameterAttributes.SpecialConstraintMask

      If (constraints And GenericParameterAttributes.ReferenceTypeConstraint) _
              <> GenericParameterAttributes.None Then _
          outputBlock.Text &= "    ReferenceTypeConstraint" & vbCrLf

      If (constraints And GenericParameterAttributes.NotNullableValueTypeConstraint) _
              <> GenericParameterAttributes.None Then _
          outputBlock.Text &= "    NotNullableValueTypeConstraint" & vbCrLf

      If (constraints And GenericParameterAttributes.DefaultConstructorConstraint) _
              <> GenericParameterAttributes.None Then _
          outputBlock.Text &= "    DefaultConstructorConstraint" & vbCrLf

   End Sub

End Class

' This code example produces output similar to the following:
'
'Type 'Sample' is generic: False
'Type 'Sample' is generic: True
'
'There are 2 elements in the List(Of Example).
'
'Listing 2 type parameters for type 'Sample[TFirst,TSecond]'.
'
'Type parameter TFirst:
'    ReferenceTypeConstraint
'    DefaultConstructorConstraint
'
'Type parameter TSecond:
'    Interface constraint: SilverlightApplication.IExampleA
'    Interface constraint: SilverlightApplication.IExampleB
'    Base type constraint: SilverlightApplication.ExampleBase

using System;
using System.Reflection;
using System.Reflection.Emit;
using System.Collections.Generic;

// Define a trivial base class and two trivial interfaces 
// to use when demonstrating constraints.
//
public class ExampleBase { }

public interface IExampleA { }

public interface IExampleB { }

// Define a trivial type that can substitute for type parameter 
// TSecond.
//
public class ExampleDerived : ExampleBase, IExampleA, IExampleB { }


public class Example
{
   // Make the output TextBlock available to all methods.
   private static System.Windows.Controls.TextBlock outputBlock;

   public static void Demo(System.Windows.Controls.TextBlock output)
   {
      outputBlock = output;

      // Define a dynamic assembly to contain the sample type. In Silverlight,
      // a dynamic assembly contains one module.
      //
      AppDomain myDomain = AppDomain.CurrentDomain;
      AssemblyName myAsmName = new AssemblyName("GenericEmitExample1");
      AssemblyBuilder myAssembly =
          myDomain.DefineDynamicAssembly(myAsmName,
              AssemblyBuilderAccess.Run);
      ModuleBuilder myModule =
          myAssembly.DefineDynamicModule(myAsmName.Name);

      // Get type objects for the base class trivial interfaces to
      // be used as constraints.
      //
      Type baseType = typeof(ExampleBase);
      Type interfaceA = typeof(IExampleA);
      Type interfaceB = typeof(IExampleB);

      // Define the sample type.
      //
      TypeBuilder myType =
          myModule.DefineType("Sample", TypeAttributes.Public);

      outputBlock.Text += String.Format("Type 'Sample' is generic: {0}",
          myType.IsGenericType) + "\n";

      // Define type parameters for the type. Until you do this, 
      // the type is not generic, as the preceding and following 
      // WriteLine statements show. The type parameter names are
      // specified as an array of strings. To make the code
      // easier to read, each GenericTypeParameterBuilder is placed
      // in a variable with the same name as the type parameter.
      // 
      string[] typeParamNames = { "TFirst", "TSecond" };
      GenericTypeParameterBuilder[] typeParams =
          myType.DefineGenericParameters(typeParamNames);

      GenericTypeParameterBuilder TFirst = typeParams[0];
      GenericTypeParameterBuilder TSecond = typeParams[1];

      outputBlock.Text += String.Format("Type 'Sample' is generic: {0}",
          myType.IsGenericType) + "\n";

      // Apply constraints to the type parameters.
      //
      // A type that is substituted for the first parameter, TFirst,
      // must be a reference type and must have a parameterless
      // constructor.
      TFirst.SetGenericParameterAttributes(
          GenericParameterAttributes.DefaultConstructorConstraint |
          GenericParameterAttributes.ReferenceTypeConstraint);

      // A type that is substituted for the second type
      // parameter must implement IExampleA and IExampleB, and
      // inherit from the trivial test class ExampleBase. The
      // interface constraints are specified as an array 
      // containing the interface types.
      TSecond.SetBaseTypeConstraint(baseType);
      Type[] interfaceTypes = { interfaceA, interfaceB };
      TSecond.SetInterfaceConstraints(interfaceTypes);

      // The following code adds a private field named ExampleField,
      // of type TFirst.
      FieldBuilder exField =
          myType.DefineField("ExampleField", TFirst,
              FieldAttributes.Private);

      // Define a static method that takes an array of TFirst and 
      // returns a List<TFirst> containing all the elements of 
      // the array. To define this method it is necessary to create
      // the type List<TFirst> by calling MakeGenericType on the
      // generic type definition, List<T>. (The T is omitted with
      // the typeof operator when you get the generic type 
      // definition.) The parameter type is created by using the
      // MakeArrayType method. 
      //
      Type listOf = typeof(List<>);
      Type listOfTFirst = listOf.MakeGenericType(TFirst);
      Type[] mParamTypes = { TFirst.MakeArrayType() };

      MethodBuilder exMethod =
          myType.DefineMethod("ExampleMethod",
              MethodAttributes.Public | MethodAttributes.Static,
              listOfTFirst,
              mParamTypes);

      // Emit the method body. 
      // The method body consists of just three opcodes, to load 
      // the input array onto the execution stack, to call the 
      // List<TFirst> constructor that takes IEnumerable<TFirst>,
      // which does all the work of putting the input elements into
      // the list, and to return, leaving the list on the stack. The
      // hard work is getting the constructor.
      // 
      // The GetConstructor method is not supported on a 
      // GenericTypeParameterBuilder, so it is not possible to get 
      // the constructor of List<TFirst> directly. There are two
      // steps, first getting the constructor of List<T> and then
      // calling a method that converts it to the corresponding 
      // constructor of List<TFirst>.
      //
      // The constructor needed here is the one that takes an
      // IEnumerable<T>. Note, however, that this is not the 
      // generic type definition of IEnumerable<T>; instead, the
      // T from List<T> must be substituted for the T of 
      // IEnumerable<T>. (This seems confusing only because both
      // types have type parameters named T. That is why this example
      // uses the somewhat silly names TFirst and TSecond.) To get
      // the type of the constructor argument, take the generic
      // type definition IEnumerable<T> (expressed as 
      // IEnumerable<> when you use the typeof operator) and 
      // call MakeGenericType with the first generic type parameter
      // of List<T>. The constructor argument list must be passed
      // as an array, with just one argument in this case.
      // 
      // Now it is possible to get the constructor of List<T>,
      // using GetConstructor on the generic type definition. To get
      // the constructor of List<TFirst>, pass List<TFirst> and
      // the constructor from List<T> to the static
      // TypeBuilder.GetConstructor method.
      //
      ILGenerator ilgen = exMethod.GetILGenerator();

      Type ienumOf = typeof(IEnumerable<>);
      Type TfromListOf = listOf.GetGenericArguments()[0];
      Type ienumOfT = ienumOf.MakeGenericType(TfromListOf);
      Type[] ctorArgs = { ienumOfT };

      ConstructorInfo ctorPrep = listOf.GetConstructor(ctorArgs);
      ConstructorInfo ctor =
          TypeBuilder.GetConstructor(listOfTFirst, ctorPrep);

      ilgen.Emit(OpCodes.Ldarg_0);
      ilgen.Emit(OpCodes.Newobj, ctor);
      ilgen.Emit(OpCodes.Ret);

      // Create the type. 
      Type finished = myType.CreateType();

      // Invoke the method.
      // ExampleMethod is not generic, but the type it belongs to is
      // generic, so in order to get a MethodInfo that can be invoked
      // it is necessary to create a constructed type. The Example 
      // class satisfies the constraints on TFirst, because it is a 
      // reference type and has a default constructor. In order to
      // have a class that satisfies the constraints on TSecond, 
      // this code example defines the ExampleDerived type. These
      // two types are passed to MakeGenericMethod to create the
      // constructed type.
      //
      Type[] typeArgs = { typeof(Example), typeof(ExampleDerived) };
      Type constructed = finished.MakeGenericType(typeArgs);
      MethodInfo mi = constructed.GetMethod("ExampleMethod");

      // Create an array of Example objects, as input to the generic
      // method. This array must be passed as the only element of an 
      // array of arguments. The first argument of Invoke is 
      // null, because ExampleMethod is static. Display the count
      // on the resulting List<Example>.
      // 
      Example[] input = { new Example(), new Example() };
      object[] arguments = { input };

      List<Example> listX =
          (List<Example>)mi.Invoke(null, arguments);

      outputBlock.Text += String.Format(
          "\nThere are {0} elements in the List<Example>.",
          listX.Count) + "\n";

      DisplayGenericParameters(finished);
   }

   private static void DisplayGenericParameters(Type t)
   {
      if (!t.IsGenericType)
      {
         outputBlock.Text += String.Format("Type '{0}' is not generic.") + "\n";
         return;
      }
      if (!t.IsGenericTypeDefinition)
      {
         t = t.GetGenericTypeDefinition();
      }

      Type[] typeParameters = t.GetGenericArguments();
      outputBlock.Text += String.Format("\nListing {0} type parameters for type '{1}'.",
          typeParameters.Length, t) + "\n";

      foreach (Type tParam in typeParameters)
      {
         outputBlock.Text += String.Format("\r\nType parameter {0}:", tParam.ToString()) + "\n";

         foreach (Type c in tParam.GetGenericParameterConstraints())
         {
            if (c.IsInterface)
            {
               outputBlock.Text += String.Format("    Interface constraint: {0}", c) + "\n";
            }
            else
            {
               outputBlock.Text += String.Format("    Base type constraint: {0}", c) + "\n";
            }
         }

         ListConstraintAttributes(tParam);
      }
   }

   // List the constraint flags. The GenericParameterAttributes
   // enumeration contains two sets of attributes, variance and
   // constraints. For this example, only constraints are used.
   //
   private static void ListConstraintAttributes(Type t)
   {
      // Mask off the constraint flags. 
      GenericParameterAttributes constraints =
          t.GenericParameterAttributes & GenericParameterAttributes.SpecialConstraintMask;

      if ((constraints & GenericParameterAttributes.ReferenceTypeConstraint)
          != GenericParameterAttributes.None)
      {
         outputBlock.Text += "    ReferenceTypeConstraint" + "\n";
      }

      if ((constraints & GenericParameterAttributes.NotNullableValueTypeConstraint)
          != GenericParameterAttributes.None)
      {
         outputBlock.Text += "    NotNullableValueTypeConstraint" + "\n";
      }

      if ((constraints & GenericParameterAttributes.DefaultConstructorConstraint)
          != GenericParameterAttributes.None)
      {
         outputBlock.Text += "    DefaultConstructorConstraint" + "\n";
      }
   }
}

/* This code example produces the following output:

Type 'Sample' is generic: False
Type 'Sample' is generic: True

There are 2 elements in the List<Example>.

Listing 2 type parameters for type 'Sample[TFirst,TSecond]'.

Type parameter TFirst:
    ReferenceTypeConstraint
    DefaultConstructorConstraint

Type parameter TSecond:
    Interface constraint: IExampleA
    Interface constraint: IExampleB
    Base type constraint: ExampleBase
 */

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

See Also

Reference

GenericTypeParameterBuilder Class

System.Reflection.Emit Namespace

Other Resources

How to: Define a Generic Type with Reflection Emit