AddIn Interface

Defines the core functionality of add-ins that you create by using the Office development tools in Visual Studio.

Namespace:  Microsoft.Office.Tools
Assembly:  Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

Syntax

'Declaration
<GuidAttribute("122bc42d-92fe-47f4-9f66-d7b282a1325b")> _
Public Interface AddIn _
    Inherits IBindableComponent, IComponent, IDisposable

[GuidAttribute("122bc42d-92fe-47f4-9f66-d7b282a1325b")]
public interface AddIn : IBindableComponent, IComponent, 
    IDisposable

The AddIn type exposes the following members.

Properties

	Name	Description
	BindingContext	Gets or sets the collection of currency managers for the IBindableComponent. (Inherited from IBindableComponent.)
	DataBindings	Gets the collection of data-binding objects for this IBindableComponent. (Inherited from IBindableComponent.)
	DataHost	Infrastructure.
	DefaultExtension	Gets the default extension for this AddIn object.
	Extension	Gets a custom extension for this AddIn object.
	HostContext	Infrastructure.
	ItemProvider	Infrastructure.
	Site	Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
	Tag	Infrastructure.

Top

Methods

	Name	Description
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)

Top

Events

	Name	Description
	BindingContextChanged	Infrastructure.
	Disposed	Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
	Shutdown	Occurs when the add-in is about to be unloaded.
	Startup	Occurs when the add-in is loaded, after all the initialization code in the assembly has run.

Top

Remarks

When you create an application-level add-in by using the Office development tools in Visual Studio, you typically do not use the AddIn interface directly. Instead, use the generated ThisAddIn class in your project. The ThisAddIn class derives most of its members from the AddInBase class. This base class redirects all calls to its members to an internal implementation of the AddIn interface in the Visual Studio Tools for Office runtime.

For more information, see Programming Application-Level Add-Ins.

Note

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: https://go.microsoft.com/fwlink/?LinkId=160658.

See Also

Reference

Microsoft.Office.Tools Namespace

Other Resources

Programming Application-Level Add-Ins