Метод FormRegionStartup.GetFormRegionIcon (Outlook)
Получает изображение значка, которое будет отображаться для определенного типа значка для области формы.
Синтаксис
выражение. GetFormRegionIcon
( _FormRegionName_
, _LCID_
, _Icon_
)
Выражение Переменная, представляющая объект FormRegionStartup.
Параметры
Имя | Обязательный или необязательный | Тип данных | Описание |
---|---|---|---|
FormRegionName | Обязательный | String | Имя области формы, которое используется при регистрации области формы в реестре Windows. |
Код языка | Обязательный | Long | Идентификатор языкового стандарта, определяющий язык, используемый Outlook в настоящее время. Это значение используется для получения строк локализации, соответствующих этому языку для области формы. |
Icon | Обязательный | OlFormRegionIcon | Константы, определяющие тип значка. |
Возвращаемое значение
Объект Variant, представляющий либо массив байтов, представляющий исходные байты файла изображения, либо объект IPictureDisp .
Замечания
Этот метод предназначен для реализации надстройкой и вызова Outlook. В рамках интерфейса FormRegionStartup этот метод и метод GetFormRegionManifest предоставляют механизм, с помощью которого надстройка может зарегистрировать область формы и предоставить Outlook XML-манифест и значки для области формы.
Если вы хотите, чтобы надстройка предоставляла значки для области формы, укажите ProgID надстройки при регистрации области формы в реестре Windows. Дополнительные сведения о регистрации области формы см. в разделе Указание областей формы в реестре Windows. Надстройка должна реализовывать методы GetFormRegionManifest и GetFormRegionIcon интерфейса FormRegionStartup .
В XML-манифесте области формы в элементе icons укажите значение addin
для каждого из дочерних элементов, в которых вы хотите использовать пользовательский значок. Реализуйте GetFormRegionIcon таким образом, чтобы, когда Outlook передает этот тип значка в качестве аргумента для значка , GetFormRegionIcon возвращает изображение настраиваемого значка. Если вы хотите, чтобы Outlook отображал значок по умолчанию, реализуйте GetFormRegionIcon таким образом, чтобы он возвращал значение NULL (Nothing в Visual Basic) для этого типа значка. GetFormRegionIcon также должен возвращать значение NULL (Nothing в Visual Basic), если значок имеет значение olFormRegionIconDefault.
При запуске Outlook считывает список областей форм из реестра Windows и кэширует данные, связанные с областями формы. Если область формы зарегистрирована с помощью ProgID, Outlook прибегнет к соответствующей надстройке, вызвав ее реализацию GetFormRegionIcon для любого значка в XML-манифесте, имеющего addin
значение дочернего элемента элемента icon . Обратите внимание, что если в реестре Windows не указать progID, Outlook не будет вызывать методы GetFormRegionManifest и GetFormRegionIcon .
См. также
Поддержка и обратная связь
Есть вопросы или отзывы, касающиеся Office VBA или этой статьи? Руководство по другим способам получения поддержки и отправки отзывов см. в статье Поддержка Office VBA и обратная связь.