ImportAttribute Třída

Definice

Obor názvů:

System.ComponentModel.Composition

Sestavení:

System.ComponentModel.Composition.dll

Balíček:

System.ComponentModel.Composition v8.0.0

Zdroj:

ImportAttribute.cs

Určuje, že vlastnost, pole nebo hodnota parametru by měla být zadána objektem 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

Dědičnost

Object

Attribute

ImportAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad ukazuje tři třídy se členy ozdobenými ImportAttributea tři exporty, které jim odpovídají.

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

Poznámky

V modelu ImportAttribute programování s atributy slouží k deklarování importů nebo závislostí dané části. Může zdobit vlastnost, pole nebo metodu. Během sestavování se importy části vyplní objektem CompositionContainer , ke kterému tato část patří, pomocí exportů poskytovaných danému CompositionContainer objektu.

To, zda import odpovídá danému exportu, se určuje především porovnáním názvu a typu kontraktu. Obvykle nemusíte při použití atributu import v kódu zadávat ani jednu z těchto možností a budou automaticky odvozeny z typu zdobeného členu. Pokud se import musí shodovat s exportem jiného typu (například podtřídu typu dekorovaného člena nebo rozhraní implementovaného tímto členem), musí být typ kontraktu explicitně zadán. Název kontraktu lze také explicitně zadat, například kvůli rozlišení více kontraktů stejného typu, ale obvykle je lepší to udělat prostřednictvím metadat. Další informace o metadatech najdete v tématu PartMetadataAttribute.

Konstruktory

ImportAttribute()	Inicializuje novou instanci ImportAttribute třídy importováním exportu s výchozím názvem kontraktu.
ImportAttribute(String)	Inicializuje novou instanci ImportAttribute třídy importováním exportu se zadaným názvem kontraktu.
ImportAttribute(String, Type)	Inicializuje novou instanci ImportAttribute třídy importováním exportu se zadaným názvem a typem kontraktu.
ImportAttribute(Type)	Inicializuje novou instanci ImportAttribute třídy importováním exportu s názvem kontraktu odvozeným od zadaného typu.

Vlastnosti

AllowDefault	Získá nebo nastaví hodnotu, která označuje, zda vlastnost, pole nebo parametr bude nastavena na jeho typ výchozí hodnotu, pokud export s názvem kontraktu není přítomen v kontejneru.
AllowRecomposition	Získá nebo nastaví hodnotu, která označuje, zda bude vlastnost nebo pole znovu zkompilován při změně exportu s odpovídajícím kontraktem v kontejneru.
ContractName	Získá název smlouvy exportu k importu.
ContractType	Získá typ exportu k importu.
RequiredCreationPolicy	Získá nebo nastaví hodnotu, která označuje, že dovozce vyžaduje konkrétní CreationPolicy pro exporty použité k uspokojení tohoto importu.
Source	Získá nebo nastaví hodnotu, která určuje rozsahy, ze kterých může být tento import splněn.
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tuto Attributetřídu . (Zděděno od Attribute)

Metody

Equals(Object)	Vrací hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí hodnotu hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě označuje, zda je hodnota této instance výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute)
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která označuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• ExportAttribute
• Přehled modelu programování s přidělenými atributy