This documentation is archived and is not being maintained.

QualificationDataAttribute Class

Provides developer-specified data for a pipeline segment.


Namespace:  System.AddIn.Pipeline
Assembly:  System.AddIn.Contract (in System.AddIn.Contract.dll)

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Interface, AllowMultiple = true)]
public sealed class QualificationDataAttribute : Attribute

The QualificationDataAttribute type exposes the following members.

Public methodQualificationDataAttributeInitializes a new instance of the QualificationDataAttribute class.

Public propertyNameGets the name, which serves as a key, of a key/value pair.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public propertyValueGets the value of a key/value pair.

Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)

You can use this attribute to assign data, in the form of name-value string pairs, for any purpose to a pipeline segment. For example, you can indicate that an add-in should be loaded into an external process.

The Rebuild and Update methods, which maintain the store of information about available pipeline segments, use this attribute to identify a segment that has qualification data.

To access the qualification data for a pipeline segment, see the QualificationData property. To enumerate the data for all the pipeline segments, see the QualificationDataItem class.

Qualification data is only read by the host and is not consumed by the add-in system in any other way.

You can apply qualification data to a pipeline segment by placing a QualificationDataAttribute attribute next to the segment attribute. For more information about pipeline segments and their attributes, see Pipeline Development.

The following example applies qualification data to an add-in.

// This pipeline segment has
// two attributes:
// 1 - An AddInAttribute to identify
//     this segment as an add-in.
// 2 - A QualificationDataAttribute to
//     indicate that the add-in should
//     be loaded into a new application domain.

    [AddIn("Calculator Add-in",Version="")]
    [QualificationData("Isolation", "NewAppDomain")]
    public class SampleV2AddIn : Calculator2

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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