HostAdapterAttribute Class

Reference

Definition

Namespace:: System.AddIn.Pipeline

Assembly:: System.AddIn.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.

Identifies an object as a host-side adapter segment of the pipeline.

public ref class HostAdapterAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class)]
public sealed class HostAdapterAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class)>]
type HostAdapterAttribute = class
    inherit Attribute

Public NotInheritable Class HostAdapterAttribute
Inherits Attribute

Inheritance: Object

Attribute
HostAdapterAttribute

Attributes: AttributeUsageAttribute

Examples

The following example identifies a host-side adapter.

// The HostAdapterAttribute identifies this class as the host-side adapter
// pipeline segment.
[HostAdapterAttribute()]
public class CalculatorContractToViewHostSideAdapter : ICalculator
{

' The HostAdapterAttribute identifies this class as the host-side adapter
' pipeline segment.
<HostAdapterAttribute()> _
Public Class CalculatorContractToViewHostSideAdapter
    Implements ICalculator

Remarks

The Rebuild and Update methods, which maintain the store of information about available pipeline segments, use this attribute to identify a host-side adapter.

This attribute should be used only on types that activate the segments of the pipeline. Types that represent objects passed between the host and the add-in do not need this attribute.

Constructors

HostAdapterAttribute()

Initializes a new instance of the HostAdapterAttribute class.

Properties

TypeId

When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

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

Share via