OutlookAddIn Interface

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

Namespace:  Microsoft.Office.Tools.Outlook
Assemblies:   Microsoft.Office.Tools.Outlook (in Microsoft.Office.Tools.Outlook.dll)
  Microsoft.Office.Tools.Outlook.v4.0.Utilities (in Microsoft.Office.Tools.Outlook.v4.0.Utilities.dll)

Syntax

'Declaration
<GuidAttribute("af8e9f42-f1c8-4a6c-8d64-d21168c8ad80")> _
Public Interface OutlookAddIn _
    Inherits AddIn, IBindableComponent, IComponent, IDisposable
[GuidAttribute("af8e9f42-f1c8-4a6c-8d64-d21168c8ad80")]
public interface OutlookAddIn : AddIn, 
    IBindableComponent, IComponent, IDisposable

The OutlookAddIn type exposes the following members.

Properties

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

Top

Methods

  Name Description
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method GetFormRegions() Infrastructure.
Public method GetFormRegions(Explorer, Type) Infrastructure.
Public method GetFormRegions(Inspector, Type) Infrastructure.

Top

Events

  Name Description
Public event BindingContextChanged Infrastructure. (Inherited from AddIn.)
Public event Disposed Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public event FormRegionFactoryResolve Occurs when the add-in loads, and when a form region name that is specified in the registry does not match the name of any form regions defined in the add-in.
Public event Shutdown Occurs when the add-in is about to be unloaded. (Inherited from AddIn.)
Public event Startup Occurs when the add-in is loaded, after all the initialization code in the assembly has run. (Inherited from AddIn.)

Top

Remarks

When you create an Outlook add-in in by using the Office development tools in Visual Studio, you typically do not use the OutlookAddIn interface directly. Instead, use the generated ThisAddIn class in your project. The ThisAddIn class derives most of its members from the OutlookAddInBase class. This base class redirects all calls to its members to an internal implementation of the OutlookAddIn 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 and the .NET Framework 4.5. 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.Outlook Namespace