ImportAttribute 类

定义

命名空间:

System.ComponentModel.Composition

程序集:

System.ComponentModel.Composition.dll

包:

System.ComponentModel.Composition v8.0.0

Source:

ImportAttribute.cs

指定属性、字段或参数值应由 CompositionContainer 对象提供。

public ref class ImportAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)]
public class ImportAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)>]
type ImportAttribute = class
    inherit Attribute

Public Class ImportAttribute
Inherits Attribute

继承

Object

Attribute

ImportAttribute

属性

AttributeUsageAttribute

示例

以下示例显示了三个类，其成员由 修饰为 ImportAttribute，三个与它们匹配的导出。

//Default export infers type and contract name from the
//exported type.  This is the preferred method.
[Export]
public class MyExport1
{
    public String data = "Test Data 1.";
}

public class MyImporter1
{
    [Import]
    public MyExport1 importedMember { get; set; }
}

public interface MyInterface
{
}

//Specifying the contract type may be important if
//you want to export a type other then the base type,
//such as an interface.
[Export(typeof(MyInterface))]
public class MyExport2 : MyInterface
{
    public String data = "Test Data 2.";
}

public class MyImporter2
{
    //The import must match the contract type!
    [Import(typeof(MyInterface))]
    public MyExport2 importedMember { get; set; }
}

//Specifying a contract name should only be
//needed in rare caes. Usually, using metadata
//is a better approach.
[Export("MyContractName", typeof(MyInterface))]
public class MyExport3 : MyInterface
{
    public String data = "Test Data 3.";
}

public class MyImporter3
{
    //Both contract name and type must match!
    [Import("MyContractName", typeof(MyInterface))]
    public MyExport3 importedMember { get; set; }
}

class Program
{

    static void Main(string[] args)
    {
        AggregateCatalog catalog = new AggregateCatalog();
        catalog.Catalogs.Add(new AssemblyCatalog(typeof(MyExport1).Assembly));
        CompositionContainer _container = new CompositionContainer(catalog);
        MyImporter1 test1 = new MyImporter1();
        MyImporter2 test2 = new MyImporter2();
        MyImporter3 test3 = new MyImporter3();
        _container.SatisfyImportsOnce(test1);
        _container.SatisfyImportsOnce(test2);
        _container.SatisfyImportsOnce(test3);
        Console.WriteLine(test1.importedMember.data);
        Console.WriteLine(test2.importedMember.data);
        Console.WriteLine(test3.importedMember.data);
        Console.ReadLine();
    }
}

'Default export infers type and contract name from the
'exported type.  This is the preferred method.
<Export()>
Public Class MyExport1
    Public ReadOnly Property data As String
        Get
            Return "Test Data 1."
        End Get
    End Property
End Class

Public Class MyImporter1

    <Import()>
    Public Property ImportedMember As MyExport1

End Class

Public Interface MyInterface

End Interface

'Specifying the contract type may be important if
'you want to export a type other then the base type,
'such as an interface.
<Export(GetType(MyInterface))>
Public Class MyExport2
    Implements MyInterface
    Public ReadOnly Property data As String
        Get
            Return "Test Data 2."
        End Get
    End Property
End Class

Public Class MyImporter2
    'The import must match the contract type!
    <Import(GetType(MyInterface))>
    Public Property ImportedMember As MyExport2
End Class

'Specifying a contract name should only be 
'needed in rare caes. Usually, using metadata
'is a better approach.
<Export("MyContractName", GetType(MyInterface))>
Public Class MyExport3
    Implements MyInterface
    Public ReadOnly Property data As String
        Get
            Return "Test Data 3."
        End Get
    End Property
End Class

Public Class MyImporter3
    'Both contract name and type must match!
    <Import("MyContractName", GetType(MyInterface))>
    Public Property ImportedMember As MyExport3
End Class



Sub Main()
    Dim catalog As AggregateCatalog = New AggregateCatalog()
    catalog.Catalogs.Add(New AssemblyCatalog(GetType(MyExport1).Assembly))
    Dim container As CompositionContainer = New CompositionContainer(catalog)
    Dim test1 As MyImporter1 = New MyImporter1()
    Dim test2 As MyImporter2 = New MyImporter2()
    Dim test3 As MyImporter3 = New MyImporter3()
    container.SatisfyImportsOnce(test1)
    container.SatisfyImportsOnce(test2)
    container.SatisfyImportsOnce(test3)
    Console.WriteLine(test1.ImportedMember.data)
    Console.WriteLine(test2.ImportedMember.data)
    Console.WriteLine(test3.ImportedMember.data)
    Console.ReadLine()
End Sub

注解

在特性化编程模型中， ImportAttribute 用于声明给定部件的导入或依赖项。 它可以修饰属性、字段或方法。 在组合期间，部件的导入将由该 CompositionContainer 部件所属的对象使用提供给该 CompositionContainer 对象的导出填充。

导入是否与给定导出匹配，主要通过比较协定名称和协定类型来确定。 通常，在代码中使用 import 属性时，不必指定其中任一项，它们将自动从修饰成员的类型推断。 如果导入必须与不同类型的导出匹配 (例如修饰成员类型的子类或该成员) 实现的接口，则必须显式指定协定类型。 还可以显式指定协定名称，例如区分具有相同类型的多个协定，但通常最好通过元数据执行此操作。 有关元数据的详细信息，请参阅 PartMetadataAttribute。

构造函数

ImportAttribute()	通过导入具有默认协定名称的导出，初始化 ImportAttribute 类的新实例。
ImportAttribute(String)	通过导入具有指定协定名称的导出，初始化 ImportAttribute 类的新实例。
ImportAttribute(String, Type)	通过导入具有指定协定名称和类型的导出，初始化 ImportAttribute 类的新实例。
ImportAttribute(Type)	通过导入具有派生自指定类型的协定名称的导出，初始化 ImportAttribute 类的新实例。

属性

AllowDefault	获取或设置一个值，该值指示在容器中不存在具有协定名称的导出时，是否将属性、字段或参数设置为其类型的默认值。
AllowRecomposition	获取或设置一个值，该值指示在容器中具有匹配协定的导出发生更改时，是否将重新组合属性或字段。
ContractName	获取要导入的导出结果的协定名称。
ContractType	获取要导入的导出结果的类型。
RequiredCreationPolicy	获取或设置一个值，该值指示导入程序需要导出结果的特定 CreationPolicy，以满足此导入。
Source	获取或设置指定可能满足此导出的域的值。
TypeId	在派生类中实现时，获取此 Attribute 的唯一标识符。 (继承自 Attribute)

方法

Equals(Object)	返回一个值，该值指示此实例是否与指定的对象相等。 (继承自 Attribute)
GetHashCode()	返回此实例的哈希代码。 (继承自 Attribute)
GetType()	获取当前实例的 Type。 (继承自 Object)
IsDefaultAttribute()	在派生类中重写时，指示此实例的值是否是派生类的默认值。 (继承自 Attribute)
Match(Object)	当在派生类中重写时，返回一个指示此实例是否等于指定对象的值。 (继承自 Attribute)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前对象的字符串。 (继承自 Object)

另请参阅

• ExportAttribute
• 特性化编程模型概述