ImportAttribute Klasse

Definition

Namespace:

System.ComponentModel.Composition

Assembly:

System.ComponentModel.Composition.dll

Paket:

System.ComponentModel.Composition v8.0.0

Quelle:

ImportAttribute.cs

Gibt an, dass eine Eigenschaft, ein Feld oder ein Parameterwert vom CompositionContainer-Objekt bereitgestellt werden soll.

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

Vererbung

Object

Attribute

ImportAttribute

Attribute

AttributeUsageAttribute

Beispiele

Das folgende Beispiel zeigt drei Klassen mit Membern, die ImportAttributemit versehen sind, und drei Exporte, die ihnen entsprechen.

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

Hinweise

Im Attributierten Programmiermodell wird verwendet ImportAttribute , um die Importe oder Abhängigkeiten eines bestimmten Teils zu deklarieren. Sie kann eine Eigenschaft, ein Feld oder eine Methode schmücken. Während der Komposition werden die Importe eines Teils durch das CompositionContainer Objekt gefüllt, zu dem dieser Teil gehört, indem die für dieses CompositionContainer Objekt bereitgestellten Exporte verwendet werden.

Ob ein Import mit einem bestimmten Export übereinstimmt, wird in erster Linie durch den Vergleich des Vertragsnamens und des Vertragstyps bestimmt. Normalerweise müssen Sie bei Verwendung des import-Attributs im Code keines dieser Beiden angeben, und sie werden automatisch aus dem Typ des ergänzten Members abgeleitet. Wenn der Import mit einem Export eines anderen Typs übereinstimmen muss (z. B. einer Unterklasse des Typs des ergänzten Elements oder einer schnittstelle, die von diesem Member implementiert wird), muss der Vertragstyp explizit angegeben werden. Der Vertragsname kann auch explizit angegeben werden, um z. B. zwischen mehreren Verträgen mit demselben Typ zu unterscheiden, aber es ist in der Regel besser, dies über Metadaten zu tun. Weitere Informationen zu Metadaten finden Sie unter PartMetadataAttribute.

Konstruktoren

ImportAttribute()	Initialisiert eine neue Instanz der ImportAttribute-Klasse, wobei der Export mit dem Standardvertragsnamen importiert wird.
ImportAttribute(String)	Initialisiert eine neue Instanz der ImportAttribute-Klasse, wobei der Export mit dem angegebenen Vertragsnamen importiert wird.
ImportAttribute(String, Type)	Initialisiert eine neue Instanz der ImportAttribute-Klasse, wobei der Export mit dem angegebenen Vertragsnamen und Typ importiert wird.
ImportAttribute(Type)	Initialisiert eine neue Instanz der ImportAttribute-Klasse, wobei der Export mit dem aus dem angegebenen Typ abgeleiteten Vertragsnamen importiert wird.

Eigenschaften

AllowDefault	Ruft einen Wert ab, der angibt, ob die Eigenschaft, das Feld oder der Parameter auf den Standardwert des Typs festgelegt werden, wenn kein Export mit dem Vertragsnamen im Container vorhanden ist, oder legt ihn fest.
AllowRecomposition	Ruft einen Wert ab, der angibt, ob die Eigenschaft oder das Feld neu erstellt wird, wenn Exporte mit einem entsprechenden Vertrag im Container geändert wurden, oder legt ihn fest.
ContractName	Ruft den Vertragsnamen des zu importierenden Exports ab.
ContractType	Ruft den Typ des zu importierenden Exports ab.
RequiredCreationPolicy	Ruft einen Wert ab, der angibt, dass der Importer eine bestimmte CreationPolicy für die Exporte benötigt, um diesen Import auszuführen, oder legt ihn fest.
Source	Ruft einen Wert ab oder legt einen Wert fest, der die Bereiche angibt, die den Import erfüllen.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• ExportAttribute
• Übersicht über das Modell der attributierten Programmierung