Метод IUIFramework::InvalidateUICommand (uiribbon.h)

  • Статья

Делает недействительным свойство, значение или состояние command платформы ленты Windows.

Синтаксис

HRESULT InvalidateUICommand(
  [in] UINT32            commandId,
  [in] UI_INVALIDATIONS  flags,
  [in] const PROPERTYKEY *key
);

Параметры

[in] commandId

Тип: UINT32

Идентификатор команды, указанный в файле ресурсов разметки.

[in] flags

Тип: UI_INVALIDATIONS

Определяет, какой аспект команды следует сделать недействительным.

Примечание Передача UI_INVALIDATIONS_ALLPROPERTIES делает недействительными все свойства, привязанные к команде, включая значение и состояние.
 

[in] key

Тип: const PROPERTYKEY*

Ключ свойства или состояния команды. Этот параметр может принимать значение NULL.

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

Тип: HRESULT

В случае успешного выполнения возвращает S_OK; В противном случае — значение ошибки из следующего списка.

Значение Описание
E_INVALIDARG Указано недопустимое значение для ключа .
E_FAIL Операция не удалась. Все команды не были признаны недействительными или ни одно из указанных свойств не поддерживается.

Комментарии

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

После аннулирования платформа запрашивает сведения о ресурсе ведущем приложении.

Если значение command становится недействительным (флаги содержат UI_INVALIDATIONS_VALUE), значение ключа равно NULL.

Если IUIFramework::InvalidateUICommand вызывается несколько раз, а значение UI_INVALIDATIONS , передаваемое в каждом вызове, указывает перекрывающиеся свойства, такие как UI_INVALIDATIONS_STATE и UI_INVALIDATIONS_ALLPROPERTIES, создается только один обратный вызов ведущего приложения.

Требования

Требование Значение
Минимальная версия клиента Windows 7 [только классические приложения]
Минимальная версия сервера Windows Server 2008 R2 [только классические приложения]
Целевая платформа Windows
Header uiribbon.h
DLL Mshtml.dll

См. также раздел

IUIFramework

UI_INVALIDATIONS

Примеры Windows Ribbon Framework