Структура DLGPAGE (compstui.h)

Структура DLGPAGE используется для указания страницы страницы свойств для функции ComPropSheet CPSUI. Адрес структуры включается в структуру COMPROPSHEETUI , а все значения элементов предоставляются вызывающим элементом ComPropSheet .

Синтаксис

typedef struct _DLGPAGE {
  WORD      cbSize;
  WORD      Flags;
  DLGPROC   DlgProc;
  LPTSTR    pTabName;
  ULONG_PTR IconID;
  union {
    WORD   DlgTemplateID;
    HANDLE hDlgTemplate;
  } DUMMYUNIONNAME;
} DLGPAGE, *PDLGPAGE;

Члены

cbSize

Предоставленный вызывающим абонентом размер структуры DLGPAGE в байтах.

Flags

Битовые флаги, предоставленные вызывающим абонентом, как описано в следующей таблице.

Флаг	Определение
DPF_ICONID_AS_HICON	Если этот параметр задан, IconID содержит дескриптор значка. Если значение не задано, IconID содержит идентификатор ресурса значка.
DPF_USE_HDLGTEMPLATE	Если задано значение , hDlgTemplate содержит дескриптор шаблона. Если значение не задано, DlgTemplateID содержит идентификатор ресурса шаблона.

Необязательный, предоставленный вызывающим методом DLGPROC, указатель на процедуру диалогового окна, используемую для обработки сообщений, отправляемых системой при возникновении событий пользователя. Если значение РАВНО NULL, CPSUI предоставляет процедуру диалогового окна. Дополнительные сведения см. в разделе Примечания ниже.

DlgProc

Определяет член DLGPROCDlgProc.

pTabName

Предоставленный вызывающей стороной указатель на строку, завершаемую null, которая будет отображаться на вкладке страницы.

IconID

Поставляемый вызывающим абонентом может иметь одно из следующих значений:

• Идентификатор ресурса значка. Это может быть определяемый приложением или один из предоставленных CPSUI идентификаторов ресурсов значка IDI_CPSUI с префиксом.

• Дескриптор значка. Если указан дескриптор, DPF_ICONID_AS_HICON необходимо задать в элементе Flags .

Указанный значок отображается на вкладке страницы. Если это значение равно нулю, значок не отображается.

DUMMYUNIONNAME

Определяет объединение DUMMYUNIONNAME .

DUMMYUNIONNAME.DlgTemplateID

Предоставленный вызывающим абонентом идентификатор ресурса для шаблона диалогового окна. Это может быть предоставленный приложением ресурс DIALOG или один из следующих предоставленных CPSUI идентификаторов (определенных в compstui.h):

Идентификатор	Тип страницы
DP_STD_DOCPROPPAGE1	Страница без просмотра, используемая для страницы макета документа печати.
DP_STD_DOCPROPPAGE2	Страница без просмотра, используемая для страницы бумаги и качества документа печати.
DP_STD_TREEVIEWPAGE	Страница универсального представления в виде дерева.

Предоставленные CPSUI идентификаторы относятся к шаблонам, которые могут отображать типы параметров CPSUI. Размер страницы для этих шаблонов составляет 252 на 216 единиц диалогового окна. Дополнительные сведения см. в разделе Страницы и шаблоны, предоставляемые CPSUI.

Этот элемент не используется, если DPF_USE_HDLGTEMPLATE задано в разделе Флаги.

DUMMYUNIONNAME.hDlgTemplate

Дескриптор, предоставленный вызывающим абонентом для структуры DLGTEMPLATE .

Используется, только если DPF_USE_HDLGTEMPLATE задано в разделе Флаги.

Комментарии

CPSUI создает страницу страницы свойств, выделяя структуру PROPSHEETPAGE и передавая ее в CreatePropertySheetPage. Если вызывающий объект указал указатель типа DLGPROC на процедуру диалогового окна в DlgProc, эта процедура используется для обработки сообщений окна страницы. Если DlgProc имеет значение NULL, используются собственные процедуры диалогового окна CPSUI.

При вызове процедуры диалогового окна, на которую указывает DlgProc со значением сообщения WM_INITDIALOG, она получает в качестве входных данных структуру PROPSHEETPAGE , а также структуру PSPINFO .

Если процедура диалогового окна, предоставляемая вызывающим абонентом, обрабатывает сообщение, она должна возвращать ненулевое значение. Если функция не обрабатывает сообщение, она должна возвращать ноль, что приводит к обработке сообщения CPSUI.

Требования

Требование	Значение
Заголовок	compstui.h (включая Compstui.h)