_FormRegionStartup.GetFormRegionManifest(String, Int32) Метод

Определение

Пространство имен:

Microsoft.Office.Interop.Outlook

Сборка:

Microsoft.Office.Interop.Outlook.dll

Получает XML-манифест для области формы.

public:
 System::Object ^ GetFormRegionManifest(System::String ^ FormRegionName, int LCID);

public object GetFormRegionManifest (string FormRegionName, int LCID);

Public Function GetFormRegionManifest (FormRegionName As String, LCID As Integer) As Object

Параметры

FormRegionName

String

Имя области формы, которое используется при регистрации области формы в реестре Windows.

LCID

Int32

Идентификатор языкового стандарта, определяющий язык, используемый Outlook в настоящее время. Это значение используется для получения строк локализации, соответствующих этому языку для области формы.

Возвращаемое значение

Object

Объект , представляющий XML-манифест для области формы. Эта XML-строка содержит характеристики области формы, такие как отображаемое имя (как указано в элементе title), любой связанный файл макета или надстройка, все поддерживаемые действия пользователя и любые строки локализации. XML-код должен соответствовать xml-схеме области формы. Дополнительные сведения о XML-схеме области формы см. в справочнике по XML-схеме Microsoft Outlook 2010, русская версия в библиотека MSDN

Комментарии

Этот метод предназначен для реализации надстройкой и вызова Outlook. В рамках FormRegionStartup интерфейса этот метод и GetFormRegionIcon(String, Int32, OlFormRegionIcon) метод предоставляют механизм, с помощью которого надстройка может зарегистрировать область формы и предоставить Outlook XML-манифест и значки для области формы.

Если вы хотите, чтобы надстройка предоставляла XML-манифест для области формы, укажите ProgID надстройки при регистрации области формы в реестре Windows. Дополнительные сведения о регистрации области формы см. в разделе Указание областей формы в методе GetFormRegionManifest реестра Windows интерфейса FormRegionStartup. Обратите внимание, что если не указать progID в реестре Windows, Outlook не будет вызывать этот метод.

Использование надстройки для предоставления XML-манифеста для области формы также означает, что вы разрешаете надстройке предоставлять любые значки для области формы. Надстройка также должна реализовывать GetFormRegionIcon интерфейса FormRegionStartup . Outlook вызовет Метод GetFormRegionIcon , чтобы получить все указанные значки надстройки для области формы. Дополнительные сведения об использовании надстройки для указания значков см. в разделе Практическое руководство. Использование надстройки для указания значков для области формы

При запуске Outlook считывает список областей форм из реестра Windows и кэширует данные. На основе этих данных, если Outlook заметит, что надстройка была указана для предоставления XML-манифеста для области формы, Outlook будет использовать ProgID, указанный в кэшированных данных, и вызовет метод GetFormRegionManifest , реализованный этой надстройкой, чтобы получить XML-код, необходимый для отображения области формы. Если XML-манифест недопустим и не соответствует XML-схеме области формы, Outlook не сможет загрузить область формы. Кроме того, если в реестре Windows не указать progID, Outlook не будет вызывать методы GetFormRegionManifest и GetFormRegionIcon .

Outlook игнорирует следующие элементы, когда надстройка предоставляет XML-манифест: