AddInBase Class

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
Protected method AddInBase Infrastructure.

Top

Properties

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

Top

Methods

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

Top

Events

Name Description
Public event BindingContextChanged Infrastructure.
Public event Disposed Infrastructure.
Public event Shutdown Occurs when the add-in is about to be unloaded.
Public event Startup Occurs when the add-in is loaded, after all the initialization code in the assembly has run.

Top

Explicit Interface Implementations

Name Description
Explicit interface implemetationPrivate method EntryPoint.BeginInit Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.EndInit Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.FinishInitialization Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.Initialize Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.InitializeDataBindings Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.OnShutdown Infrastructure.
Explicit interface implemetationPrivate method EntryPoint.OnStartup Infrastructure.
Explicit interface implemetationPrivate method IAddInExtension.CreateRibbonExtensibilityObject Infrastructure.
Explicit interface implemetationPrivate method IAddInExtension.CreateRibbonObjects Infrastructure.
Explicit interface implemetationPrivate method IAddInExtension.RequestComAddInAutomationService Infrastructure.
Explicit interface implemetationPrivate method IAddInExtension.RequestService Infrastructure.
Explicit interface implemetationPrivate property 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.

See Also

Reference

Microsoft.Office.Tools Namespace

Other Resources

Programming Application-Level Add-Ins

Getting Started Programming Application-Level Add-Ins

Events in Office Projects