Класс COleCmdUI

Реализует метод для MFC, позволяющий обновлять состояние объектов ИП, связанных с зависимыми от IOleCommandTargetфункциями вашего приложения.

Синтаксис

class COleCmdUI : public CCmdUI

Участники

Открытые конструкторы

Имя	Описание
COleCmdUI::COleCmdUI	Формирует объект COleCmdUI.

Открытые методы

Имя	Описание
COleCmdUI::Enable	Задает или очищает флаг команды включения.
COleCmdUI::SetCheck	Задает состояние включенной или выключенной команды переключателя.
COleCmdUI::SetText	Возвращает текстовое имя или строку состояния для команды.

Замечания

В приложении, которое не включено для DocObjects, когда пользователь просматривает меню в приложении, MFC обрабатывает уведомления UPDATE_COMMAND_UI. Каждому уведомлению присваивается объект CCmdUI , который можно управлять для отражения состояния определенной команды. Однако если приложение включено для DocObjects, MFC обрабатывает UPDATE_OLE_COMMAND_UI уведомления и назначает COleCmdUI объекты.

COleCmdUI позволяет DocObject получать команды, которые возникают в пользовательском интерфейсе контейнера (например, FileNew, Open, Print и т. д.), и позволяет контейнеру получать команды, которые возникают в пользовательском интерфейсе DocObject. Хотя IDispatch можно использовать для отправки одинаковых команд, IOleCommandTarget предоставляет более простой способ запроса и выполнения, так как он использует стандартный набор команд, обычно без аргументов, а сведения о типе не используются. COleCmdUI можно использовать для включения, обновления и задания других свойств команд пользовательского интерфейса DocObject. При вызове команды вызовите COleServerDoc::OnExecOleOleCmd.

Дополнительные сведения о DocObjects см. в разделе CDocObjectServer и CDocObjectServerItem.

Иерархия наследования

CCmdUI

COleCmdUI

Требования

Заголовок: afxdocob.h

COleCmdUI::COleCmdUI

Создает объект, связанный COleCmdUI с определенной командой пользовательского интерфейса.

COleCmdUI(
    OLECMD* rgCmds,
    ULONG cCmds,
    const GUID* m_pGroup);

Параметры

rgCmds
Список поддерживаемых команд, связанных с заданным GUID. Структура OLECMD связывает команды с флагами команд.

cCmds
Количество команд в rgCmds.

pGroup
Указатель на GUID, определяющий набор команд.

Замечания

Объект COleCmdUI предоставляет программный интерфейс для обновления объектов пользовательского интерфейса DocObject, таких как элементы меню или кнопки панели управления. Объекты пользовательского интерфейса можно включить, отключить, проверить и /или очистить через COleCmdUI объект.

COleCmdUI::Enable

Вызовите эту функцию, чтобы задать флаг COleCmdUI команды объекта на OLECOMDF_ENABLED, который сообщает интерфейсу, что команда доступна и включена, или очистить флаг команды.

virtual void Enable(BOOL bOn);

Параметры

бон
Указывает, должна ли команда, связанная с COleCmdUI объектом, быть включена или отключена. Ненулевое включение команды; 0 отключает команду.

COleCmdUI::SetCheck

Вызовите эту функцию, чтобы задать состояние команды включения или выключения.

virtual void SetCheck(int nCheck);

Параметры

nCheck
Значение, определяющее состояние для установки команды включения или выключения переключателя. Значения:

значение	Description
1	Задает команду включено.
2	Задает команду для неопределенного состояния; Состояние не может быть определено, так как атрибут этой команды находится как в состояниях включено, так и отключено в соответствующем выборе.
любое другое значение	Задает для команды значение off.

COleCmdUI::SetText

Вызовите эту функцию, чтобы вернуть текстовое имя или строку состояния для команды.

virtual void SetText(LPCTSTR lpszText);

Параметры

lpszText
Указатель на текст, используемый с командой.

См. также

Класс CCmdUI
Диаграмма иерархии