AddInBase Class

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

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

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

The AddInBase type exposes the following members.

  NameDescription
Protected methodAddInBaseInfrastructure.
Top

  NameDescription
Public propertyBaseGets the AddIn object that this AddInBase object extends.
Public propertyBindingContextInfrastructure.
Public propertyDataBindingsInfrastructure.
Public propertyDataHostInfrastructure.
Public propertyHostContextInfrastructure.
Public propertyItemProviderInfrastructure.
Public propertySiteInfrastructure.
Public propertyTagInfrastructure.
Top

  NameDescription
Public methodBeginInitInfrastructure.
Protected methodCreateRibbonExtensibilityObjectReturns an object that implements the Microsoft.Office.Core.IRibbonExtensibility interface.
Protected methodCreateRibbonObjectsReturns an array of IRibbonExtension objects to the CreateRibbonExtensibilityObject method. The objects represent the Ribbons to display at run time.
Public methodDisposeReleases the resources used by the AddInBase.
Public methodEndInitInfrastructure.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodFinishInitializationInfrastructure.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Protected methodGetHostItem<T>Infrastructure.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitializeInfrastructure.
Protected methodInitializeDataBindingsInfrastructure.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnShutdownInfrastructure.
Protected methodOnStartupInfrastructure.
Protected methodRequestComAddInAutomationServiceReturns an object in your add-in that can be used by other solutions.
Protected methodRequestServiceReturns an object that extends a feature in a Microsoft Office application.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventBindingContextChangedInfrastructure.
Public eventDisposedInfrastructure.
Public eventShutdownOccurs when the add-in is about to be unloaded.
Public eventStartupOccurs when the add-in is loaded, after all the initialization code in the assembly has run.
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft