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

Определение

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

Microsoft.Office.Interop.Outlook

Сборка:

Microsoft.Office.Interop.Outlook.dll

Получает изображение значка, которое будет отображаться для определенного типа значка для области формы.

public:
 System::Object ^ GetFormRegionIcon(System::String ^ FormRegionName, int LCID, Microsoft::Office::Interop::Outlook::OlFormRegionIcon Icon);

public object GetFormRegionIcon (string FormRegionName, int LCID, Microsoft.Office.Interop.Outlook.OlFormRegionIcon Icon);

Public Function GetFormRegionIcon (FormRegionName As String, LCID As Integer, Icon As OlFormRegionIcon) As Object

Параметры

FormRegionName

String

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

LCID

Int32

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

Icon

OlFormRegionIcon

Константы, определяющие тип значка.

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

Object

Объект , представляющий массив байтов, представляющий исходные байты файла изображения или объект IPictureDisp.

Комментарии

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

Если вы хотите, чтобы надстройка предоставляла значки для области формы, укажите ProgID надстройки при регистрации области формы в реестре Windows. Дополнительные сведения о регистрации области формы см. в разделе Указание областей формы в реестре WindowsGetFormRegionManifest и методах GetFormRegionIcon интерфейса FormRegionStartup .

В XML-манифесте области формы в элементе icons укажите надстройку значения для каждого из дочерних элементов, в которых вы хотите использовать пользовательский значок. Реализуйте GetFormRegionIcon таким образом, чтобы, когда Outlook передает этот тип значка в качестве аргумента для Icon, GetFormRegionIcon возвращает изображение настраиваемого значка. Если вы хотите, чтобы Outlook отображал значок по умолчанию, реализуйте GetFormRegionIcon таким образом, чтобы он возвращал Nothing (пустую ссылку (Nothing в Visual Basic) в C#) для этого типа значка. GetFormRegionIcon также должен возвращать Nothing (пустая ссылка (Nothing в Visual Basic) в C#, если Icon имеет значение olFormRegionIconDefault.

При запуске Outlook считывает список областей форм из реестра Windows и кэширует данные, связанные с областями формы. Если область формы зарегистрирована с помощью ProgID, Outlook прибегнет к соответствующей надстройке, вызвав ее реализацию GetFormRegionIcon для любого значка в XML-манифесте, который имеет addin в качестве значения дочернего элемента элемента icon. Обратите внимание, что если не указать progID в реестре Windows, Outlook не будет вызывать методы GetFormRegionManifest и GetFormRegionIcon .