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メンバーを持つ 3 つのクラスと、それらに一致する 3 つのエクスポートを示します。

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

注釈

Attributed Programming Model では、 ImportAttribute を使用して、特定のパーツのインポート (依存関係) を宣言します。 プロパティ、フィールド、またはメソッドを装飾できます。 コンポジション中、パーツのインポートは、そのオブジェクトに提供されるCompositionContainerエクスポートを使用して、そのパーツが属するオブジェクトによって塗りつぶCompositionContainerされます。

インポートが特定のエクスポートと一致するかどうかは、主にコントラクト名とコントラクトの種類を比較することによって決定されます。 通常、コードで import 属性を使用する場合は、これらのいずれかを指定する必要はありません。これらは、装飾されたメンバーの型から自動的に推論されます。 インポートが異なる型のエクスポート (装飾されたメンバーの型のサブクラス、またはそのメンバーによって実装されたインターフェイスなど) と一致する必要がある場合は、コントラクト型を明示的に指定する必要があります。 コントラクト名は、たとえば、同じ型の複数のコントラクトを区別するために明示的に指定することもできますが、通常はメタデータを使用して行うことをお勧めします。 メタデータの詳細については、「」を参照してください 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
• 属性付きプログラミング モデルの概要