_FormRegionStartup.GetFormRegionStorage Method

Definition

Namespace:

Microsoft.Office.Interop.Outlook

Assembly:

Microsoft.Office.Interop.Outlook.dll

Obtains appropriate storage for a form region based on the specified information.

public:
 System::Object ^ GetFormRegionStorage(System::String ^ FormRegionName, System::Object ^ Item, int LCID, Microsoft::Office::Interop::Outlook::OlFormRegionMode FormRegionMode, Microsoft::Office::Interop::Outlook::OlFormRegionSize FormRegionSize);

public object GetFormRegionStorage (string FormRegionName, object Item, int LCID, Microsoft.Office.Interop.Outlook.OlFormRegionMode FormRegionMode, Microsoft.Office.Interop.Outlook.OlFormRegionSize FormRegionSize);

Public Function GetFormRegionStorage (FormRegionName As String, Item As Object, LCID As Integer, FormRegionMode As OlFormRegionMode, FormRegionSize As OlFormRegionSize) As Object

Parameters

FormRegionName

String

The internal name of the form region. This can be indicated by the <name> tag in the corresponding form region XML manifest.

Item

Object

The Outlook item object that caused the loading of the form region.

LCID

Int32

The current locale ID.

FormRegionMode

OlFormRegionMode

The mode that the form region is being loaded into.

FormRegionSize

OlFormRegionSize

The type of form region being loaded, either adjoining or separate.

Returns

Object

A Object representing the storage that Outlook has allocated for the form region. The type of the return value can be: String (string in C#) representing that the return value is a local path to an Outlook Form Storage (.OFS) file; Byte() representing that the return value is an array of bytes that contains the contents of the .OFS file; IStorage representing that the return value is a COM storage object IStorage (for C++ only); Nothing or Null, representing that Outlook could not allocate storage for this form region and will not load the form region.

Remarks

The add-in must check for the return value of GetFormRegionStorage. A form region will not load if any of the following is true of the returned storage:

For examples of add-ins in C# and Visual Basic .NET that implement the FormRegionStartup interface, see code sample downloads on MSDN.