AddInBase Class

Article
06/14/2013

Provides the base class for the ThisAddIn class in application-level add-ins that you create by using Visual Studio.

Inheritance Hierarchy

System.Object
Microsoft.Office.Tools.AddInBase
Microsoft.Office.Tools.Outlook.OutlookAddInBase

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

Syntax

'Declaration
Public MustInherit Class AddInBase _
    Implements IAddInExtension, IExtension, EntryPoint, ISupportInitialize,  _
    IBindableComponent, IComponent, IDisposable

public abstract class AddInBase : IAddInExtension, 
    IExtension, EntryPoint, ISupportInitialize, IBindableComponent, IComponent, 
    IDisposable

The AddInBase type exposes the following members.

Constructors

	Name	Description
	AddInBase	Infrastructure.

Top

Properties

	Name	Description
	Base	Gets the AddIn object that this AddInBase object extends.
	BindingContext	Infrastructure.
	DataBindings	Infrastructure.
	DataHost	Infrastructure.
	HostContext	Infrastructure.
	ItemProvider	Infrastructure.
	Site	Infrastructure.
	Tag	Infrastructure.

Top

Methods

	Name	Description
	BeginInit	Infrastructure.
	CreateRibbonExtensibilityObject	Returns an object that implements the Microsoft.Office.Core.IRibbonExtensibility interface.
	CreateRibbonObjects	Returns an array of IRibbonExtension objects to the CreateRibbonExtensibilityObject method. The objects represent the Ribbons to display at run time.
	Dispose	Releases the resources used by the AddInBase.
	EndInit	Infrastructure.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FinishInitialization	Infrastructure.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetHostItem<T>	Infrastructure.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	Infrastructure.
	InitializeDataBindings	Infrastructure.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnShutdown	Infrastructure.
	OnStartup	Infrastructure.
	RequestComAddInAutomationService	Returns an object in your add-in that can be used by other solutions.
	RequestService	Returns an object that extends a feature in a Microsoft Office application.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	BindingContextChanged	Infrastructure.
	Disposed	Infrastructure.
	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

Explicit Interface Implementations

	Name	Description
	EntryPoint.BeginInit	Infrastructure.
	EntryPoint.EndInit	Infrastructure.
	EntryPoint.FinishInitialization	Infrastructure.
	EntryPoint.Initialize	Infrastructure.
	EntryPoint.InitializeDataBindings	Infrastructure.
	EntryPoint.OnShutdown	Infrastructure.
	EntryPoint.OnStartup	Infrastructure.
	IAddInExtension.CreateRibbonExtensibilityObject	Infrastructure.
	IAddInExtension.CreateRibbonObjects	Infrastructure.
	IAddInExtension.RequestComAddInAutomationService	Infrastructure.
	IAddInExtension.RequestService	Infrastructure.
	IExtension.ExtensionBase	Infrastructure.

Top

Remarks

The AddInBase class provides functionality that is shared by all add-ins that you create by using the Office development tools in Visual Studio. The ThisAddIn class in add-in projects derives most of its members from the AddInBase class. For more information, see Programming Application-Level Add-Ins.

Usage

This type is used only in Office projects that target the .NET Framework 4 and the .NET Framework 4.5. The assembly that defines this type is not part of the Visual Studio Tools for Office runtime. You must deploy this assembly with your solution. For more information, see Assemblies in the Visual Studio Tools for Office Runtime.

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.

Share via