QualificationDataAttribute Class

Reference

Definition

Namespace:: System.AddIn.Pipeline

Assembly:: System.AddIn.Contract.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides developer-specified data for a pipeline segment.

public ref class QualificationDataAttribute sealed : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface, AllowMultiple=true)>]
type QualificationDataAttribute = class
    inherit Attribute

Public NotInheritable Class QualificationDataAttribute
Inherits Attribute

Inheritance: Object

Attribute
QualificationDataAttribute

Attributes: AttributeUsageAttribute

Examples

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="2.0.0.0")]
    [QualificationData("Isolation", "NewAppDomain")]
    public class SampleV2AddIn : Calculator2
    {

' 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:="2.0.0.0")> _
<QualificationData("Isolation", "NewAppDomain")> _
    Public Class SampleV2AddIn

Remarks

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.

Constructors

QualificationDataAttribute(String, String)

Initializes a new instance of the QualificationDataAttribute class.

Properties

Name	Gets the name, which serves as a key, of a key/value pair.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)
Value	Gets the value of a key/value pair.

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
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

_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)

Applies to

Deila með