ImportAttribute Classe

Definição

Namespace:

System.ComponentModel.Composition

Assembly:

System.ComponentModel.Composition.dll

Pacote:

System.ComponentModel.Composition v8.0.0

Origem:

ImportAttribute.cs

Especifica que um valor de parâmetro, campo ou propriedade deve ser fornecido pelo objeto 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

Herança

Object

Attribute

ImportAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo a seguir mostra três classes com membros decorados com o ImportAttributee três exportações que correspondem a elas.

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

Comentários

No Modelo de Programação Atribuída, o ImportAttribute é usado para declarar as importações ou dependências de uma determinada parte. Ele pode decorar uma propriedade, um campo ou um método. Durante a composição, as importações de uma parte serão preenchidas pelo CompositionContainer objeto ao qual essa parte pertence, usando as exportações fornecidas para esse CompositionContainer objeto.

Se uma importação corresponde a uma determinada exportação é determinada principalmente comparando o nome do contrato e o tipo de contrato. Normalmente, você não precisa especificar nenhum deles ao usar o atributo de importação no código e eles serão automaticamente inferidos do tipo do membro decorado. Se a importação precisar corresponder a uma exportação de um tipo diferente (por exemplo, uma subclasse do tipo do membro decorado ou uma interface implementada por esse membro), o tipo de contrato deverá ser especificado explicitamente. O nome do contrato também pode ser especificado explicitamente, por exemplo, para distinguir entre vários contratos com o mesmo tipo, mas geralmente é melhor fazer isso por meio de metadados. Para obter mais informações sobre metadados, consulte PartMetadataAttribute.

Construtores

ImportAttribute()	Inicializa uma nova instância da classe ImportAttribute, importando a exportação com o nome do contrato padrão.
ImportAttribute(String)	Inicializa uma nova instância da classe ImportAttribute, importando a exportação com o nome do contrato especificado.
ImportAttribute(String, Type)	Inicializa uma nova instância da classe ImportAttribute, importando a exportação com o tipo e o nome do contrato especificados.
ImportAttribute(Type)	Inicializa uma nova instância da classe ImportAttribute, importando a exportação com o nome do contrato derivado do tipo especificado.

Propriedades

AllowDefault	Obtém ou define um valor que indica se a propriedade, o campo ou o parâmetro será definido para o valor padrão de seu tipo quando uma exportação com o nome do contrato não estiver presente no contêiner.
AllowRecomposition	Obtém ou define um valor que indica se a propriedade ou o campo será recomposto quando exportações com um contrato correspondente tiverem mudado no contêiner.
ContractName	Obtém o nome do contrato da exportação a importar.
ContractType	Obtém o tipo de exportação a importar.
RequiredCreationPolicy	Obtém ou define um valor que indica que o importador exige uma CreationPolicy específica para as exportações usadas para atender a essa importação.
Source	Obtém ou define um valor que especifica os escopos dos quais essa importação pode ser atendida.
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Confira também

• ExportAttribute
• Visão geral do modelo de programação atribuído