ImportAttribute Klasse

Definition

Gibt an, dass eine Eigenschaft, ein Feld oder ein Parameterwert vom CompositionContainer-Objekt bereitgestellt werden soll.Specifies that a property, field, or parameter value should be provided by the 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
type ImportAttribute = class
    inherit Attribute
Public Class ImportAttribute
Inherits Attribute
Vererbung
ImportAttribute
Attribute

Beispiele

Das folgende Beispiel zeigt drei Klassen mit Membern, die mit dem ImportAttribute versehen sind, und drei Exporte, die Ihnen entsprechen.The following example shows three classes with members decorated with the ImportAttribute, and three exports that match them.

//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 der ImportAttribute verwendet, um die Importe oder Abhängigkeiten eines bestimmten Teils zu deklarieren.In the Attributed Programming Model, the ImportAttribute is used to declare the imports, or dependencies, of a given part. Sie kann eine Eigenschaft, ein Feld oder eine Methode ergänzen.It can decorate a property, a field, or a method. Während der Komposition werden die Importe eines Teils durch das CompositionContainer-Objekt gefüllt, zu dem dieser Teil gehört, indem die Exporte verwendet werden, die für dieses CompositionContainer-Objekt bereitgestellt werden.During composition, a part's imports will be filled by the CompositionContainer object to which that part belongs, by using the exports provided to that CompositionContainer object.

Ob ein Import mit einem bestimmten Export übereinstimmt, wird hauptsächlich durch Vergleichen des Vertrags namens und des Vertrags Typs bestimmt.Whether an import matches a given export is determined primarily by comparing the contract name and the contract type. Normalerweise müssen Sie keines dieser Elemente angeben, wenn Sie das Import-Attribut im Code verwenden, und Sie werden automatisch vom Typ des ergänzten Members abgeleitet.Ordinarily, you do not have to specify either of these when using the import attribute in code, and they will be automatically inferred from the type of the decorated member. Wenn der Import einem Export eines anderen Typs entsprechen muss (z. b. eine Unterklasse des Typs des ergänzten Members oder eine Schnittstelle, die von diesem Member implementiert wird), muss der Vertragstyp explizit angegeben werden.If the import must match an export of a different type (for example, a subclass of the type of the decorated member, or an interface implemented by that member), then the contract type must be explicitly specified. Der Vertrags Name kann auch explizit angegeben werden, z. b. um zwischen mehreren Verträgen desselben Typs zu unterscheiden, aber es ist in der Regel besser, dies durch Metadaten zu tun.The contract name can also be explicitly specified, for example to distinguish between multiple contracts with the same type, but it is usually better to do this through metadata. Weitere Informationen zu Metadaten finden Sie unter PartMetadataAttribute.For more information about metadata, see PartMetadataAttribute.

Konstruktoren

ImportAttribute()

Initialisiert eine neue Instanz der ImportAttribute-Klasse, wobei der Export mit dem Standardvertragsnamen importiert wird.Initializes a new instance of the ImportAttribute class, importing the export with the default contract name.

ImportAttribute(String)

Initialisiert eine neue Instanz der ImportAttribute-Klasse, wobei der Export mit dem angegebenen Vertragsnamen importiert wird.Initializes a new instance of the ImportAttribute class, importing the export with the specified contract name.

ImportAttribute(String, Type)

Initialisiert eine neue Instanz der ImportAttribute-Klasse, wobei der Export mit dem angegebenen Vertragsnamen und Typ importiert wird.Initializes a new instance of the ImportAttribute class, importing the export with the specified contract name and type.

ImportAttribute(Type)

Initialisiert eine neue Instanz der ImportAttribute-Klasse, wobei der Export mit dem aus dem angegebenen Typ abgeleiteten Vertragsnamen importiert wird.Initializes a new instance of the ImportAttribute class, importing the export with the contract name derived from the specified type.

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.Gets or sets a value that indicates whether the property, field, or parameter will be set to its type's default value when an export with the contract name is not present in the container.

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.Gets or sets a value that indicates whether the property or field will be recomposed when exports with a matching contract have changed in the container.

ContractName

Ruft den Vertragsnamen des zu importierenden Exports ab.Gets the contract name of the export to import.

ContractType

Ruft den Typ des zu importierenden Exports ab.Gets the type of the export to import.

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.Gets or sets a value that indicates that the importer requires a specific CreationPolicy for the exports used to satisfy this import.

Source

Ruft einen Wert ab oder legt einen Wert fest, der die Bereiche angibt, die den Import erfüllen.Gets or sets a value that specifies the scopes from which this import may be satisfied.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(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.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(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.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für:

Siehe auch