FormRegionManifest Interface
Represents a form region manifest that describes how the form region appears in Outlook.
Namespace: Microsoft.Office.Tools.Outlook
Assembly: Microsoft.Office.Tools.Outlook (in Microsoft.Office.Tools.Outlook.dll)
Syntax
'Declaration
<GuidAttribute("d4086552-24ea-462c-bb44-0a1e811e40c3")> _
Public Interface FormRegionManifest
[GuidAttribute("d4086552-24ea-462c-bb44-0a1e811e40c3")]
public interface FormRegionManifest
The FormRegionManifest type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Contact | Gets or sets the name that appears in the Choose Form dialog box in Outlook for replacement and replace-all form regions. |
|
CustomActions | Gets a collection that contains all of the custom actions that appear in the Custom Actions group on the Ribbon of the Outlook item that displays the form region. |
|
Description | Gets or sets the text that appears in the Choose Form dialog box in Outlook for replacement and replace-all form regions. |
|
DisplayAfter | Gets or sets the name of the form region to display before this form region. |
|
ExactMessageClass | Gets or sets a value that indicates whether the form region is displayed by derived message classes. |
|
FormRegionFactory | Infrastructure. |
|
FormRegionName | Gets or sets the text that appears on the Ribbon of an Outlook item or in the header text of an adjoining form region. |
|
FormRegionType | Gets or sets a FormRegionType that determines how the form region appears in an Outlook form. |
|
Hidden | Gets or sets a value that indicates whether replacement and replace-all form regions appear in the Choose Form dialog box in Outlook. |
|
Icons | Gets or sets a FormRegionManifestIcons that specifies the icons that appear for separate, replacement, or replace-all form regions. |
|
LoadLegacyForm | Gets or sets a value that indicates whether Outlook loads legacy forms before loading this form region. |
|
Locked | Gets or sets a value that indicates whether the properties of the FormRegionManifest can be modified. |
|
RibbonAccelerator | Gets or sets the keyboard shortcut of separate, replacement, and replace-all form regions. |
|
ShowInspectorCompose | Gets or sets a value that indicates whether to display the form region when an Outlook Inspector is in compose mode. |
|
ShowInspectorRead | Gets or sets a value that indicates whether to display the form region when an Outlook Inspector is in read mode. |
|
ShowReadingPane | Gets or sets a value that indicates whether to display the form region in the Reading Pane. |
|
Title | Gets or sets the name that appears in the Actions menu and Choose Form dialog box in Outlook for replacement and replace-all form regions. |
|
Version | Gets or sets the version number of the form region. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
ToXml() | Creates a string that represents the FormRegionManifest as XML. |
|
ToXml(XmlWriter) | Creates a string that represents the FormRegionManifest as XML and saves it to an XmlTextWriter instance. |
Top
Remarks
A form region manifest is a collection of properties that describe how the form region appears in Outlook. For example, you can specify whether the form region should appear in the Reading Pane of an Outlook item, or provide the title that you would like to appear in the Actions menu or Choose Form dialog box when users select a replacement or replace-all form region in Outlook.
You can set these properties at design time in the Properties window, or at run time before Outlook retrieves the form region manifest from the Outlook add-in.
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. 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.