AddInBase Class

Reference

Definition

Namespace:: Microsoft.Office.Tools

Assembly:: Microsoft.Office.Tools.Common.v4.0.Utilities.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 the base class for the ThisAddIn class in application-level add-ins that you create by using Visual Studio.

public ref class AddInBase abstract : IDisposable, Microsoft::Office::Tools::IAddInExtension, System::ComponentModel::IComponent, System::ComponentModel::ISupportInitialize, System::Windows::Forms::IBindableComponent

[System.ComponentModel.ToolboxItem(false)]
public abstract class AddInBase : IDisposable, Microsoft.Office.Tools.IAddInExtension, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent

[<System.ComponentModel.ToolboxItem(false)>]
type AddInBase = class
    interface IAddInExtension
    interface IExtension
    interface EntryPoint
    interface ISupportInitialize
    interface IBindableComponent
    interface IComponent
    interface IDisposable

Public MustInherit Class AddInBase
Implements IAddInExtension, IBindableComponent, IComponent, IDisposable, ISupportInitialize

Inheritance: Object
AddInBase

Derived: Microsoft.Office.Tools.Outlook.OutlookAddInBase

Attributes: ToolboxItemAttribute

Implements: EntryPoint IAddInExtension IExtension IComponent ISupportInitialize IDisposable IBindableComponent

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 VSTO Add-Ins.

Usage

This type is used only in Office projects that target the .NET Framework 4 or later. 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.

Constructors

AddInBase(Factory, IServiceProvider, String, String)

Properties

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

Methods

BeginInit()
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()
FinishInitialization()
GetHostItem<T>(Type, String)
Initialize()
InitializeDataBindings()
OnShutdown()
OnStartup()
RequestComAddInAutomationService()	Returns an object in your add-in that can be used by other solutions.
RequestService(Guid)	Returns an object that extends a feature in a Microsoft Office application.

Events

BindingContextChanged
Disposed
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.

Explicit Interface Implementations

EntryPoint.BeginInit()
EntryPoint.EndInit()
EntryPoint.FinishInitialization()
EntryPoint.Initialize()
EntryPoint.InitializeDataBindings()
EntryPoint.OnShutdown()
EntryPoint.OnStartup()
IAddInExtension.CreateRibbonExtensibilityObject()
IAddInExtension.CreateRibbonObjects()
IAddInExtension.RequestComAddInAutomationService()
IAddInExtension.RequestService(Guid)
IExtension.ExtensionBase

Applies to