Microsoft.Office.Tools.Outlook Namespace

 

The Microsoft.Office.Tools.Outlook namespace contains a set of classes and interfaces that enable you to create form regions that customize Microsoft Office Outlook forms.

ClassDescription
System_CAPS_pubclassControlNotFoundException

Represents errors that occur when a control is not found in the Microsoft.Vbe.Interop.Forms.UserForm of an imported form region.

System_CAPS_pubclassFormRegionBase

Represents an Outlook form region that is based on a user control.

System_CAPS_pubclassFormRegionCollectionBase

Provides access to IFormRegion objects in an Outlook add-in project.

System_CAPS_pubclassFormRegionMessageClassAttribute

Represents an attribute that specifies the name of a Microsoft Office Outlook message class to associate with the form region.

System_CAPS_pubclassFormRegionNameAttribute

Represents the name that uniquely identifies a form region across all Outlook add-ins.

System_CAPS_pubclassFormRegionStorageNullException

Represents an error that occurs when the GetFormRegionStorage method of the form region factory class returns null.

System_CAPS_pubclassImportedFormRegionBase

Represents an Outlook form region that is based on a user control.

System_CAPS_pubclassInvalidMessageClassException

Represents errors that occur when a specified message class name is not valid.

System_CAPS_pubclassOutlookAddInBase

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

InterfaceDescription
System_CAPS_pubinterfaceFactory

Provides methods you can use to perform miscellaneous tasks in an Outlook add-in, such as creating form region controls, form region manifest objects, and custom actions.

System_CAPS_pubinterfaceFormRegionControl

Represents an Outlook form region that is based on a user control.

System_CAPS_pubinterfaceFormRegionCustomAction

Represents a custom action that appears in the Custom Actions group on the Ribbon of an Outlook item.

System_CAPS_pubinterfaceFormRegionCustomActionCollection

Represents a collection of FormRegionCustomAction objects.

System_CAPS_pubinterfaceFormRegionFactoryResolveEventArgs

Provides data for the FormRegionFactoryResolve event of an OutlookAddIn.

System_CAPS_pubinterfaceFormRegionInitializingEventArgs

Provides data for the FormRegionInitializing event of the form region factory class.

System_CAPS_pubinterfaceFormRegionManifest

Represents a form region manifest that describes how the form region appears in Outlook.

System_CAPS_pubinterfaceFormRegionManifestIcons

Represents a collection of icons that appear for separate, replace, and replace-all form regions.

System_CAPS_pubinterfaceIFormRegion

Defines an interface that exposes methods that are used by the events of the form region.

System_CAPS_pubinterfaceIFormRegionFactory

Defines an interface that creates instances of classes that implement IFormRegion.

System_CAPS_pubinterfaceIImportedFormRegionExtension

Represents an extension of a ImportedFormRegion object.

System_CAPS_pubinterfaceImportedFormRegion

Represents a Microsoft Office Outlook form region that is based on an Outlook Form Storage (*.ofs) file.

System_CAPS_pubinterfaceOutlookAddIn

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

DelegateDescription
System_CAPS_pubdelegateFormRegionFactoryResolveEventHandler

Represents the method that will handle the FormRegionFactoryResolve event of an OutlookAddIn.

System_CAPS_pubdelegateFormRegionInitializingEventHandler

Represents the method that will handle the FormRegionInitializing event of the form region.

EnumerationDescription
System_CAPS_pubenumFormRegionCustomActionAddressLike

Specifies how to address the target item that appears when the user executes the custom action.

System_CAPS_pubenumFormRegionCustomActionBody

Specifies how the Message or Notes field of an Outlook item is included to the reply that appears when the user executes the custom action.

System_CAPS_pubenumFormRegionCustomActionMethod

Specifies how to respond when the user executes the custom action.

System_CAPS_pubenumFormRegionKindConstants

Contains constants that specify whether the form region that a form region factory creates is based on a user control or an Outlook Form Storage (.ofs) file.

System_CAPS_pubenumFormRegionType

Specifies the way the form region appears in Microsoft Office Outlook.

Form regions are represented by the FormRegionBase and ImportedFormRegionBase classes. When you add an Outlook Form Region item to an Outlook add-in project, Visual Studio adds a class to the project that inherits from one of these two classes.

If you import a form region into an Outlook add-in project by using the New Outlook Form Region wizard, Visual Studio creates a form region class that inherits from ImportedFormRegionBase.

If you select Design a new form region on the first page of the New Outlook Form Region wizard, Visual Studio adds a form region class that inherits from FormRegionBase.

In both cases, Visual Studio adds a form region factory class to the project that implements the IFormRegionFactory interface. The form region factory class is responsible for creating new instances of the form region.

The Microsoft.Office.Tools.Outlook namespace also contains classes and attributes that represent the type of form region, the unique name of the form region, the properties that define how the form region appears in Outlook, and the message class names of Outlook items with which the form region is associated.

Return to top
Show: