Obtains appropriate storage for a form region based on the specified information.
Assembly: Microsoft.Office.Interop.Outlook (in Microsoft.Office.Interop.Outlook.dll)
[DispIdAttribute()] Object GetFormRegionStorage( string FormRegionName, Object Item, int LCID, OlFormRegionMode FormRegionMode, OlFormRegionSize FormRegionSize )
- Type: System.String
The internal name of the form region. This can be indicated by the <name> tag in the corresponding form region XML manifest.
- Type: System.Object
The Outlook item object that caused the loading of the form region.
- Type: System.Int32
The current locale ID.
- Type: Microsoft.Office.Interop.Outlook.OlFormRegionMode
The mode that the form region is being loaded into.
- Type: Microsoft.Office.Interop.Outlook.OlFormRegionSize
The type of form region being loaded, either adjoining or separate.
Return valueType: System.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.
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:
The returned storage is a .OFS file specified with a non-local path.
The returned storage is a file but is not an .OFS file saved from the forms designer.
For examples of add-ins in C# and Visual Basic .NET that implement the FormRegionStartup interface, see code sample downloads on MSDN.