The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ImportAttribute Class

.NET Framework (current version)

Other Versions

Specifies that a property, field, or parameter value should be provided by the CompositionContainer.object

Namespace: System.ComponentModel.Composition
Assembly: System.ComponentModel.Composition (in System.ComponentModel.Composition.dll)

Inheritance Hierarchy

System::Object
System::Attribute
System.ComponentModel.Composition::ImportAttribute

Syntax

C++

[AttributeUsageAttribute(AttributeTargets::Property | AttributeTargets::Field | AttributeTargets::Parameter, 
	AllowMultiple = false, Inherited = false)]
public ref class ImportAttribute : Attribute

Constructors

	Name	Description
	ImportAttribute()	Initializes a new instance of the ImportAttribute class, importing the export with the default contract name.
	ImportAttribute(String^)	Initializes a new instance of the ImportAttribute class, importing the export with the specified contract name.
	ImportAttribute(String^, Type^)	Initializes a new instance of the ImportAttribute class, importing the export with the specified contract name and type.
	ImportAttribute(Type^)	Initializes a new instance of the ImportAttribute class, importing the export with the contract name derived from the specified type.

Properties

	Name	Description
	AllowDefault	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	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	Gets the contract name of the export to import.
	ContractType	Gets the type of the export to import.
	RequiredCreationPolicy	Gets or sets a value that indicates that the importer requires a specific CreationPolicy for the exports used to satisfy this import.
	Source	Gets or sets a value that specifies the scopes from which this import may be satisfied.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

Methods

	Name	Description
	Equals(Object^)	This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Returns the hash code for this instance.(Inherited from Attribute.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)
	Match(Object^)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	_Attribute::GetIDsOfNames(Guid%, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)
	_Attribute::GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)
	_Attribute::GetTypeInfoCount(UInt32%)	Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)
	_Attribute::Invoke(UInt32, Guid%, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

In the Attributed Programming Model, the ImportAttribute is used to declare the imports, or dependencies, of a given part. It can decorate a property, a field, or a method. 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.

Whether an import matches a given export is determined primarily by comparing the contract name and the contract type. 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. 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. 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. For more information about metadata, see PartMetadataAttribute.

Examples

The following example shows three classes with members decorated with the ImportAttribute, and three exports that match them.

C++

No code example is currently available or this language may not be supported.

Version Information

.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 4.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

English	Dansk	Deutsch	Español
Français	Italiano	Nederlands	Polski
Português	Svenska	Türkçe	Pусский
日本語	한국어	简体中文	繁體中文