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)

[GuidAttribute("d4086552-24ea-462c-bb44-0a1e811e40c3")]
public interface FormRegionManifest

NameDescription
System_CAPS_pubpropertyContact

Gets or sets the name that appears in the Choose Form dialog box in Outlook for replacement and replace-all form regions.

System_CAPS_pubpropertyCustomActions

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.

System_CAPS_pubpropertyDescription

Gets or sets the text that appears in the Choose Form dialog box in Outlook for replacement and replace-all form regions.

System_CAPS_pubpropertyDisplayAfter

Gets or sets the name of the form region to display before this form region.

System_CAPS_pubpropertyExactMessageClass

Gets or sets a value that indicates whether the form region is displayed by derived message classes.

System_CAPS_pubpropertyFormRegionFactory

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubpropertyFormRegionName

Gets or sets the text that appears on the Ribbon of an Outlook item or in the header text of an adjoining form region.

System_CAPS_pubpropertyFormRegionType

Gets or sets a FormRegionType that determines how the form region appears in an Outlook form.

System_CAPS_pubpropertyHidden

Gets or sets a value that indicates whether replacement and replace-all form regions appear in the Choose Form dialog box in Outlook.

System_CAPS_pubpropertyIcons

Gets or sets a FormRegionManifestIcons that specifies the icons that appear for separate, replacement, or replace-all form regions.

System_CAPS_pubpropertyLoadLegacyForm

Gets or sets a value that indicates whether Outlook loads legacy forms before loading this form region.

System_CAPS_pubpropertyLocked

Gets or sets a value that indicates whether the properties of the FormRegionManifest can be modified.

System_CAPS_pubpropertyRibbonAccelerator

Gets or sets the keyboard shortcut of separate, replacement, and replace-all form regions.

System_CAPS_pubpropertyShowInspectorCompose

Gets or sets a value that indicates whether to display the form region when an Outlook Inspector is in compose mode.

System_CAPS_pubpropertyShowInspectorRead

Gets or sets a value that indicates whether to display the form region when an Outlook Inspector is in read mode.

System_CAPS_pubpropertyShowReadingPane

Gets or sets a value that indicates whether to display the form region in the Reading Pane.

System_CAPS_pubpropertyTitle

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.

System_CAPS_pubpropertyVersion

Gets or sets the version number of the form region.

NameDescription
System_CAPS_pubmethodToXml()

Creates a string that represents the FormRegionManifest as XML.

System_CAPS_pubmethodToXml(XmlWriter)

Creates a string that represents the FormRegionManifest as XML and saves it to an XmlTextWriter instance.

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.

System_CAPS_noteNote

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.

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 or later. 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: http://go.microsoft.com/fwlink/?LinkId=160658.

Return to top
Show: