FormRegion Interface

Definition

Namespace:

Microsoft.Office.Interop.Outlook

Assembly:

Microsoft.Office.Interop.Outlook.dll

Represents a form region in an Outlook form.

public interface class FormRegion : Microsoft::Office::Interop::Outlook::_FormRegion, Microsoft::Office::Interop::Outlook::FormRegionEvents_Event

[System.Runtime.InteropServices.Guid("0006305A-0000-0000-C000-000000000046")]
public interface FormRegion : Microsoft.Office.Interop.Outlook._FormRegion, Microsoft.Office.Interop.Outlook.FormRegionEvents_Event

Public Interface FormRegion
Implements _FormRegion, FormRegionEvents_Event

Derived

Microsoft.Office.Interop.Outlook.FormRegionClass

Attributes

GuidAttribute

Implements

_FormRegion FormRegionEvents_Event

Remarks

This is a .NET interface derived from a COM coclass that is required by managed code for interoperability with the corresponding COM object. Use this derived interface to access all method, property, and event members of the COM object. However, if a method or event you want to use shares the same name under the same COM object, cast to the corresponding primary interface to call the method, and cast to the latest events interface to connect to the event. Refer to this topic for information about the COM object. For information about the method and property members of the COM object, see _FormRegion. For information about the event members of the COM object, see FormRegionEvents_Event.

The FormRegion object allows an add-in to add code behind a form region in a custom form to modify the appearance and behavior of the form region.

To obtain an instance of the FormRegion object, an add-in must implement the FormRegionStartup interface. Outlook allocates storage for the form region, instantiates an instance of the FormRegion object, and returns the FormRegion object in the GetFormRegionStorage(String, Object, Int32, OlFormRegionMode, OlFormRegionSize) method.

When the add-in closes the frame for the form region, the add-in must release the object for the form region.

For more information on programming a form region, see Extending a Form Region with an Add-in

Properties

Application	Returns an Application object that represents the parent Outlook application for the object. Read-only. (Inherited from _FormRegion)
Class	Returns an OlObjectClass constant indicating the object's class. Read-only. (Inherited from _FormRegion)
Detail	Returns or sets a String (string in C#) representing the text displayed at runtime in the header after the display name of an adjoining form region. Read/write. (Inherited from _FormRegion)
DisplayName	Returns a String (string in C#) representing the display name of the form region. Read-only. (Inherited from _FormRegion)
EnableAutoLayout	Returns or sets a Boolean (bool in C#) that specifies whether to use the automatic layout resizing feature when designing form regions in the forms designer. Read/write (Inherited from _FormRegion)
Form	Returns an Object representing the MSForms.UserForm object. Read-only. (Inherited from _FormRegion)
FormRegionMode	Returns an OlFormRegionMode constant that indicates whether the form region is in a read page, compose page, or Reading Pane. Read-only. (Inherited from _FormRegion)
Inspector	Returns an Inspector object representing the Inspector that hosts the form region. Read-only. (Inherited from _FormRegion)
InternalName	Returns a String (string in C#) that represents the internal programmatic name of the form region as defined in the manifest for the form region. Read-only. (Inherited from _FormRegion)
IsExpanded	Returns a Boolean (bool in C#) that indicates if the form region is expanded. Read-only. (Inherited from _FormRegion)
Item	Returns an Object corresponding to the Outlook item bound to the form region. Read-only. (Inherited from _FormRegion)
Language	Returns an Integer (int in C#) value that indicates the LCID for the current language. Read-only. (Inherited from _FormRegion)
Parent	Returns the parent Object of the form region. Read-only. (Inherited from _FormRegion)
Session	Returns the NameSpace object for the current session. Read-only. (Inherited from _FormRegion)
SuppressControlReplacement	Returns or sets a Boolean (bool in C#) that disables Outlook from automatically replacing a Forms 2.0 control by a themed Outlook control at design time and runtime. Read/write. (Inherited from _FormRegion)
Visible	Returns or sets a Boolean (bool for C#) value that indicates whether the form region is visible or hidden. Read/write. (Inherited from _FormRegion)

Methods

Reflow()	Causes Outlook to recalculate the height of an adjoining form region to display all the visible controls in the form region. (Inherited from _FormRegion)
Select()	Makes the form region the active form region such that it becomes visible. (Inherited from _FormRegion)
SetControlItemProperty(Object, String)	Binds an explicit built-in property or a custom property to a control in the form region. (Inherited from _FormRegion)

Events

Close	Represents the closing of the frame for a form region, which occurs just before the Close event of the Inspector associated with the Outlook item. (Inherited from FormRegionEvents_Event)
Expanded	Occurs when the form region expands or collapses (Inherited from FormRegionEvents_Event)