Метод IUICommandHandler::UpdateProperty (uiribbon.h)

Отвечает на запросы на обновление свойств от платформы ленты Windows.

Синтаксис

HRESULT UpdateProperty(
  [in]           UINT32            commandId,
  [in]           REFPROPERTYKEY    key,
  [in, optional] const PROPVARIANT *currentValue,
  [out]          PROPVARIANT       *newValue
);

Параметры

[in] commandId

Тип: UINT32

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

[in] key

Тип: REFPROPERTYKEY

Ключ свойства для обновления.

[in, optional] currentValue

Тип: const PROPVARIANT*

Указатель на текущее значение ключа. Этот параметр может принимать значение NULL.

[out] newValue

Тип: PROPVARIANT*

При возврате этим методом содержит указатель на новое значение ключа.

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

Тип: HRESULT

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Комментарии

Этот метод должен возвращать до выполнения последующих вызовов платформы ленты.

Значения свойств Command, такие как UI_PKEY_Enabled или UI_PKEY_Label, задаются с помощью вызовов SetUICommandProperty или InvalidateUICommand.

Требования

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

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

IUICommandHandler

Примеры Windows Ribbon Framework