Класс CSnapInPropertyPageImpl
Этот класс предоставляет методы реализации объекта страницы свойств оснастки.
Внимание
Этот класс и его члены нельзя использовать в приложениях, выполняемых в среде выполнения Windows.
Синтаксис
CSnapInPropertyPageImpl : public CDialogImplBase
Участники
Открытые конструкторы
| Имя | Описание |
|---|---|
| CSnapInPropertyPageImpl::CSnapInPropertyPageImpl | Конструктор. |
Открытые методы
| Имя | Описание |
|---|---|
| CSnapInPropertyPageImpl::CancelToClose | Изменяет состояние кнопок "ОК " и "Отмена ". |
| CSnapInPropertyPageImpl::Create | Инициализирует только что созданный CSnapInPropertyPageImpl объект. |
| CSnapInPropertyPageImpl::OnApply | Вызывается платформой, когда пользователь нажимает кнопку "Применить сейчас " при использовании листа свойств типа мастера. |
| CSnapInPropertyPageImpl::OnHelp | Вызывается платформой, когда пользователь нажимает кнопку справки при использовании листа свойств типа мастера. |
| CSnapInPropertyPageImpl::OnKillActive | Вызывается платформой, когда текущая страница больше не активна. |
| CSnapInPropertyPageImpl::OnQueryCancel | Вызывается платформой, когда пользователь нажимает кнопку "Отмена " и перед отменой. |
| CSnapInPropertyPageImpl::OnReset | Вызывается платформой, когда пользователь нажимает кнопку сброса при использовании листа свойств типа мастера. |
| CSnapInPropertyPageImpl::OnSetActive | Вызывается платформой, когда текущая страница становится активной. |
| CSnapInPropertyPageImpl::OnWizardBack | Вызывается платформой, когда пользователь нажимает кнопку "Назад" при использовании листа свойств типа мастера. |
| CSnapInPropertyPageImpl::OnWizardFinish | Вызывается платформой, когда пользователь нажимает кнопку "Готово" при использовании листа свойств типа мастера. |
| CSnapInPropertyPageImpl::OnWizardNext | Вызывается платформой, когда пользователь нажимает кнопку "Далее " при использовании листа свойств типа мастера. |
| CSnapInPropertyPageImpl::QuerySiblings | Перенаправит текущее сообщение на все страницы листа свойств. |
| CSnapInPropertyPageImpl::SetModified | Вызов для активации или отключения кнопки "Применить сейчас ". |
Открытые члены данных
| Имя | Описание |
|---|---|
| CSnapInPropertyPageImpl::m_psp | Структура Windows PROPSHEETPAGE , используемая CSnapInPropertyPageImpl объектом. |
Замечания
CSnapInPropertyPageImpl предоставляет базовую реализацию для объекта страницы свойств оснастки. Основные функции страницы свойств оснастки реализованы с помощью нескольких различных интерфейсов и типов карт.
Иерархия наследования
CDialogImplBase
CSnapInPropertyPageImpl
Требования
Заголовок: atlsnap.h
CSnapInPropertyPageImpl::CancelToClose
Вызовите эту функцию после того, как неустранимое изменение было внесено в данные на странице таблицы модальных свойств.
void CancelToClose();
Замечания
Эта функция изменит кнопку "ОК" на "Закрыть" и отключит кнопку "Отмена". Это изменение предупреждает пользователя о том, что изменение является постоянным, и изменения не могут быть отменены.
Функция-член CancelToClose ничего не делает в листе свойств без режима, так как в листе свойств без режима нет кнопки "Отмена " по умолчанию.
CSnapInPropertyPageImpl::CSnapInPropertyPageImpl
Формирует объект CSnapInPropertyPageImpl.
CSnapInPropertyPageImpl(LPCTSTR lpszTitle = NULL);
Параметры
lpszTitle
[in] Заголовок страницы свойства.
Замечания
Чтобы инициализировать базовую структуру, вызовите CSnapInPropertyPageImpl::Create.
CSnapInPropertyPageImpl::Create
Вызовите эту функцию, чтобы инициализировать базовую структуру страницы свойств.
HPROPSHEETPAGE Create();
Возвращаемое значение
Дескриптор PROPSHEETPAGE структуры, содержащей атрибуты только что созданного листа свойств.
Замечания
Перед вызовом этой функции необходимо сначала вызвать CSnapInPropertyPageImpl::CSnapInPropertyPageImpl .
CSnapInPropertyPageImpl::m_psp
m_psp — это структура, члены которой хранят характеристики PROPSHEETPAGE.
PROPSHEETPAGE m_psp;
Замечания
Используйте эту структуру для инициализации внешнего вида страницы свойств после его создания.
Дополнительные сведения об этой структуре, включая список его членов, см . в разделе PROPSHEETPAGE в пакете SDK для Windows.
CSnapInPropertyPageImpl::OnApply
Эта функция-член вызывается, когда пользователь нажимает кнопку "ОК " или "Применить сейчас ".
BOOL OnApply();
Возвращаемое значение
Ненулевое значение, если изменения принимаются; в противном случае — 0.
Замечания
Перед OnApply вызовом платформы необходимо вызвать SetModified и задать для него значение TRUE. Эта кнопка активирует кнопку "Применить сейчас ", как только пользователь вносит изменения на страницу свойств.
Переопределите эту функцию-член, чтобы указать, какое действие выполняет программа, когда пользователь нажимает кнопку "Применить сейчас ". При переопределении функция должна возвращать значение TRUE, чтобы принимать изменения и FALSE, чтобы предотвратить принятие изменений.
Реализация по умолчанию OnApply возвращает ЗНАЧЕНИЕ TRUE.
CSnapInPropertyPageImpl::OnHelp
Эта функция-член вызывается, когда пользователь нажимает кнопку справки для страницы свойств.
void OnHelp();
Замечания
Переопределите эту функцию-член, чтобы отобразить справку для страницы свойств.
CSnapInPropertyPageImpl::OnKillActive
Эта функция-член вызывается, когда страница больше не является активной.
BOOL OnKillActive();
Возвращаемое значение
Ненулевое значение, если данные были успешно обновлены; в противном случае — 0.
Замечания
Переопределите эту функцию-член для выполнения специальных задач проверки данных.
CSnapInPropertyPageImpl::OnQueryCancel
Эта функция-член вызывается, когда пользователь нажимает кнопку "Отмена " и перед выполнением действия отмены.
BOOL OnQueryCancel();
Возвращаемое значение
Ненулевое разрешение операции отмены; в противном случае — 0.
Замечания
Переопределите эту функцию-член, чтобы указать действие, которое выполняет программа, когда пользователь нажимает кнопку "Отмена ".
Реализация по умолчанию OnQueryCancel возвращает ЗНАЧЕНИЕ TRUE.
CSnapInPropertyPageImpl::OnReset
Эта функция-член вызывается, когда пользователь нажимает кнопку "Отмена ".
void OnReset();
Замечания
При вызове этой функции изменения всех страниц свойств, сделанных пользователем ранее нажатием кнопки "Применить сейчас ", удаляются, а лист свойств сохраняет фокус.
Переопределите эту функцию-член, чтобы указать, какое действие выполняет программа, когда пользователь нажимает кнопку "Отмена ".
CSnapInPropertyPageImpl::OnSetActive
Эта функция-член вызывается при выборе пользователем страницы и становится активной страницей.
BOOL OnSetActive();
Возвращаемое значение
Ненулевое значение, если страница была успешно настроена; в противном случае — 0.
Замечания
Переопределите эту функцию-член для выполнения задач при активации страницы. Переопределение этой функции-члена должно вызывать версию по умолчанию перед выполнением любой другой обработки.
Реализация по умолчанию возвращает ЗНАЧЕНИЕ TRUE.
CSnapInPropertyPageImpl::OnWizardBack
Эта функция-член вызывается, когда пользователь нажимает кнопку "Назад " в мастере.
BOOL OnWizardBack();
Возвращаемое значение
0, чтобы автоматически перейти на предыдущую страницу.
-1, чтобы предотвратить изменение страницы.
Чтобы перейти к странице, отличной от следующей, верните идентификатор диалогового окна, который будет отображаться.
Замечания
Переопределите эту функцию-член, чтобы указать некоторые действия, которые пользователь должен предпринять при нажатии кнопки "Назад ".
CSnapInPropertyPageImpl::OnWizardFinish
Эта функция-член вызывается, когда пользователь нажимает кнопку "Готово " в мастере.
BOOL OnWizardFinish();
Возвращаемое значение
Ненулевое значение, если лист свойств уничтожается после завершения работы мастера; в противном случае ноль.
Замечания
Переопределите эту функцию-член, чтобы указать некоторые действия, которые пользователь должен предпринять при нажатии кнопки "Готово ".
CSnapInPropertyPageImpl::OnWizardNext
Эта функция-член вызывается, когда пользователь нажимает кнопку "Далее " в мастере.
BOOL OnWizardNext();
Возвращаемое значение
0, чтобы автоматически перейти на следующую страницу.
-1, чтобы предотвратить изменение страницы.
Чтобы перейти к странице, отличной от следующей, верните идентификатор диалогового окна, который будет отображаться.
Замечания
Переопределите эту функцию-член, чтобы указать некоторые действия, которые пользователь должен предпринять при нажатии кнопки "Далее ".
CSnapInPropertyPageImpl::QuerySiblings
Вызовите эту функцию-член, чтобы перенаправить сообщение на каждую страницу в листе свойств.
LRESULT QuerySiblings(WPARAM wParam, LPARAM lParam);
Параметры
wParam
[in] Указывает дополнительные сведения, зависящие от сообщений.
lParam
[in] Указывает дополнительные сведения, зависящие от сообщений.
Возвращаемое значение
Ненулевое значение, если сообщение не должно пересылаться на следующую страницу свойств; в противном случае ноль.
Замечания
Если страница возвращает ненулевое значение, лист свойств не отправляет сообщение на последующие страницы.
CSnapInPropertyPageImpl::SetModified
Вызовите эту функцию-член, чтобы включить или отключить кнопку "Применить сейчас ", исходя из того, следует ли применять параметры на странице свойств к соответствующему внешнему объекту.
void SetModified(BOOL bChanged = TRUE);
Параметры
bChanged
[in] ЗНАЧЕНИЕ TRUE, указывающее, что параметры страницы свойств были изменены с момента последнего применения; ЗНАЧЕНИЕ FALSE, указывающее, что применены параметры страницы свойств или должны игнорироваться.
Замечания
Лист свойств отслеживает, какие страницы "грязные", то есть страницы свойств, для которых вы назвали SetModified( TRUE ). Кнопка "Применить сейчас " всегда будет включена при вызове SetModified( TRUE ) одной из страниц. Кнопка "Применить сейчас " будет отключена при вызове SetModified( FALSE ) одной из страниц, но только если ни одна из других страниц не является "грязной".