ImportAttribute Класс

Определение

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

System.ComponentModel.Composition

Сборка:

System.ComponentModel.Composition.dll

Пакет:

System.ComponentModel.Composition v8.0.0

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

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

Соответствие импорта данному экспорту определяется главным образом путем сравнения имени контракта и типа контракта. Обычно при использовании атрибута импорта в коде не требуется указывать ни один из них, и они будут автоматически выведены из типа декорированного элемента. Если импорт должен соответствовать экспорту другого типа (например, подкласс типа декорированного элемента или интерфейс, реализованный этим элементом), то тип контракта должен быть явно указан. Имя контракта также можно указать явным образом, например для различения нескольких контрактов с одинаковым типом, но обычно это лучше сделать с помощью метаданных. Дополнительные сведения о метаданных см. в разделе 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
• Общие сведения о модели атрибутивного программирования