ImportAttribute Класс

Определение

Пространство имен:

System.ComponentModel.Composition

Сборка:

System.ComponentModel.Composition.dll

Пакет:

System.ComponentModel.Composition v11.0.0-preview.4.26230.115

Исходный код:

ImportAttribute.cs

Указывает, что значение свойства, поля или параметра должно быть предоставлено объектом CompositionContainer.object.

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 объекта.

Независимо от того, соответствует ли импорт заданному экспорту, определяется главным образом путем сравнения имени контракта и типа контракта. Как правило, при использовании атрибута импорта в коде не нужно указывать ни один из них, и они автоматически выводятся из типа декорированного элемента. Если импорт должен соответствовать экспорту другого типа (например, подкласса типа декорированного элемента или интерфейса, реализованного этим элементом), то тип контракта должен быть явно указан. Имя контракта также можно явно указать, например, чтобы различать несколько контрактов с одинаковым типом, но это обычно лучше сделать с помощью метаданных. Дополнительные сведения о метаданных см. в разделе PartMetadataAttribute.

Конструкторы

Имя	Описание
ImportAttribute()	Инициализирует новый экземпляр ImportAttribute класса, импортируя экспорт с именем контракта по умолчанию.
ImportAttribute(String, Type)	Инициализирует новый экземпляр ImportAttribute класса, импортируя экспорт с указанным именем контракта и типом.
ImportAttribute(String)	Инициализирует новый экземпляр ImportAttribute класса, импортируя экспорт с указанным именем контракта.
ImportAttribute(Type)	Инициализирует новый экземпляр ImportAttribute класса, импортируя экспорт с именем контракта, производным от указанного типа.

Свойства

Имя	Описание
AllowDefault	Возвращает или задает значение, указывающее, будет ли свойство, поле или параметр иметь значение по умолчанию типа, если экспорт с именем контракта отсутствует в контейнере.
AllowRecomposition	Возвращает или задает значение, указывающее, будет ли свойство или поле перекомпоированы при экспорте с соответствующим контрактом в контейнере.
ContractName	Возвращает имя контракта импорта.
ContractType	Возвращает тип импорта.
RequiredCreationPolicy	Возвращает или задает значение, указывающее, что для импорта требуется конкретный CreationPolicy экспорт, используемый для выполнения этого импорта.
Source	Возвращает или задает значение, указывающее области, из которых может быть удовлетворен этот импорт.

См. также раздел

• ExportAttribute
• Обзор модели программирования