Estrutura PROPSHEETHEADER
Define o quadro e as páginas de uma folha de propriedades.
Sintaxe
typedef struct {
DWORD dwSize;
DWORD dwFlags;
HWND hwndParent;
HINSTANCE hInstance;
union {
HICON hIcon;
LPCTSTR pszIcon;
};
LPCTSTR pszCaption;
UINT nPages;
union {
UINT nStartPage;
LPCTSTR pStartPage;
};
union {
LPCPROPSHEETPAGE ppsp;
HPROPSHEETPAGE *phpage;
};
PFNPROPSHEETCALLBACK pfnCallback;
union {
HBITMAP hbmWatermark;
LPCTSTR pszbmWatermark;
};
HPALETTE hplWatermark;
union {
HBITMAP hbmHeader;
LPCSTR pszbmHeader;
};
} PROPSHEETHEADER, *LPPROPSHEETHEADER;
Membros
dwSize
Tipo: DWORD
Tamanho, em bytes, dessa estrutura. O gerenciador de folhas de propriedades usa esse membro para determinar qual versão da estrutura PROPSHEETHEADER você está usando. Para obter mais informações, consulte Comentários.
dwFlags
Tipo: DWORD
Sinalizadores que indicam quais opções usar ao criar a página da folha de propriedades. Esse membro pode ser uma combinação dos valores a seguir.
| Valor | Significado |
|---|---|
| PSH_DEFAULT (0x00000000) | Usa o significado padrão para todos os membros da estrutura e cria uma folha de propriedades normal. Esse sinalizador tem um valor igual a zero e não é combinado com outros sinalizadores. |
| PSH_AEROWIZARD (0x00004000) | Versão 6.00 e posterior. Cria uma folha de propriedades do assistente que usa o estilo Aero. O sinalizador PSH_WIZARD também deve ser definido. O modelo STA (apartamento de thread único) deve ser usado. |
| PSH_HASHELP (0x00000200) | Permite que páginas de folha de propriedades exibam um botão Ajuda. Você também deve definir o sinalizador PSP_HASHELP na estrutura PROPSHEETPAGE da página quando a página for criada. Se qualquer uma das páginas da folha de propriedades inicial habilitar um botão ajuda , PSH_HASHELP será definido automaticamente. Se nenhuma das páginas iniciais habilitar um botão de Ajuda , você deverá definir explicitamente PSH_HASHELP se quiser ter botões de Ajuda em qualquer página que possa ser adicionada posteriormente. Não há suporte para esse sinalizador em conjunto com PSH_AEROWIZARD. |
| PSH_HEADER (0x00080000) | Versão 5.80 e posterior. Indica que um bitmap de cabeçalho será usado com um assistente do Wizard97. Você também deve definir o sinalizador PSH_WIZARD97. Se o sinalizador PSH_USEHBMHEADER estiver definido, o bitmap de cabeçalho será obtido do membro hbmHeader . Caso contrário, o bitmap de cabeçalho será obtido do membro pszbmHeader . Não há suporte para esse sinalizador em conjunto com PSH_AEROWIZARD. |
| PSH_HEADERBITMAP (0x08000000) | Versão 6.00 e posterior. O membro pszbmHeader especifica um bitmap exibido na área de cabeçalho. Deve ser usado em combinação com PSH_AEROWIZARD. |
| PSH_MODELESS (0x00000400) | Faz com que a função PropertySheet crie a folha de propriedades como uma caixa de diálogo de modelagem em vez de como uma caixa de diálogo modal. Quando esse sinalizador é definido, PropertySheet retorna imediatamente após a caixa de diálogo ser criada e o valor retornado de PropertySheet é o identificador de janela para a caixa de diálogo da folha de propriedades. Não há suporte para esse sinalizador em conjunto com PSH_AEROWIZARD. |
| PSH_NOAPPLYNOW (0x00000080) | Remove o botão Aplicar . Não há suporte para esse sinalizador em conjunto com PSH_AEROWIZARD. |
| PSH_NOCONTEXTHELP (0x02000000) | Versão 5.80 e posterior. Remove o botão de Ajuda contextual ("?"), que geralmente está presente na barra de legenda de folhas de propriedades. Esse sinalizador não é válido para assistentes. Consulte Sobre folhas de propriedades para obter uma discussão sobre como remover o botão ajuda da barra de legenda para versões anteriores dos controles comuns. Não há suporte para esse sinalizador em conjunto com PSH_AEROWIZARD. |
| PSH_NOMARGIN (0x10000000) | Versão 6.00 ou posterior. Especifica que nenhuma margem é inserida entre a página e o quadro. Deve ser usado em combinação com PSH_AEROWIZARD. |
| PSH_PROPSHEETPAGE (0x00000008) | Usa o membro ppsp e ignora o membro phpage ao criar as páginas para a folha de propriedades. |
| PSH_PROPTITLE (0x00000001) | Indica que o pszCaption é o nome da coisa para a qual as propriedades estão sendo mostradas. O Windows faz um ajuste dependente de versão e idioma no legenda. Por exemplo, em inglês, a frase "Properties for" é acrescentada a um pszCaption não vazio (e se o pszCaption produzir um legenda vazio, o título será simplesmente "Propriedades"). Se esse sinalizador for omitido, o pszCaption será usado sem filtro. |
| PSH_RESIZABLE (0x04000000) | Permite que o assistente seja redimensionado pelo usuário. Maximizar e minimizar os botões aparecem no quadro do assistente e o quadro é considerável. Para usar esse sinalizador, você também deve definir PSH_AEROWIZARD. |
| PSH_RTLREADING (0x00000800) | Define a folha de propriedades ou a janela do assistente como ordem de leitura da direita para a esquerda (RTL), apropriada para idiomas como hebraico e árabe. Se esse sinalizador não for especificado, as janelas da folha de propriedades serão padrão para a ordem de leitura da esquerda para a direita (LTR) e as janelas do assistente corresponderão à ordem de leitura da página atual. |
| PSH_STRETCHWATERMARK (0x00040000) | Alonga a marca d'água em assistentes no estilo Wizard97. Não há suporte para esse sinalizador em conjunto com PSH_AEROWIZARD. Esse sinalizador de estilo só está incluído para fornecer compatibilidade com versões anteriores para determinados aplicativos. Seu uso não é recomendado e só é compatível com as versões de controles comuns 4.0 e 4.01. Com controles comuns versão 5.80 e posterior, esse sinalizador é ignorado. |
| PSH_USECALLBACK (0x00000100) | Chama a função especificada pelo parâmetro pfnCallback quando determinados eventos ocorrem. Para obter mais informações, consulte a descrição da função de retorno de chamada PFNPROPSHEETCALLBACK . |
| PSH_USEHBMHEADER (0x00100000) | Versão 5.80. Obtém o bitmap de cabeçalho do membro hbmHeader em vez do membro pszbmHeader . Você também deve definir o sinalizador PSH_AEROWIZARD ou o sinalizador PSH_WIZARD97 junto com o sinalizador PSH_HEADER. |
| PSH_USEHBMWATERMARK (0x00010000) | Versão 5.80. Obtém o bitmap de marca d'água do membro hbmWatermark em vez do membro pszbmWatermark . Você também deve definir PSH_WIZARD97 e PSH_WATERMARK. Não há suporte para esse sinalizador em conjunto com PSH_AEROWIZARD. |
| PSH_USEHICON (0x00000002) | Usa hIcon como o ícone pequeno na barra de título da caixa de diálogo da folha de propriedades. |
| PSH_USEHPLWATERMARK (0x00020000) | Versão 5.80. Usa a estrutura HPALETTE apontada pelo membro hplWatermark em vez da paleta padrão para desenhar o bitmap de marca d'água e/ou bitmap de cabeçalho para um assistente do Wizard97. Você também deve definir PSH_WIZARD97 e PSH_WATERMARK ou PSH_HEADER. Não há suporte para esse sinalizador em conjunto com PSH_AEROWIZARD. |
| PSH_USEICONID (0x00000004) | Usa pszIcon como o nome do recurso de ícone para carregar e usar como o pequeno ícone na barra de título da caixa de diálogo da folha de propriedades. |
| PSH_USEPAGELANG (0x00200000) | Versão 5.80. Especifica que o idioma da folha de propriedades será obtido do recurso da primeira página. Essa página deve ser especificada pelo identificador de recurso. |
| PSH_USEPSTARTPAGE (0x00000040) | Usa o membro pStartPage em vez do membro nStartPage ao exibir a página inicial da folha de propriedades. |
| PSH_WATERMARK (0x00008000) | Versão 5.80. Especifica que um bitmap de marca d'água será usado com um assistente do Wizard97 em páginas que tenham o estilo PSP_HIDEHEADER. Você também deve definir o sinalizador PSH_WIZARD97. O bitmap de marca d'água é obtido do membro pszbmWatermark , a menos que PSH_USEHBMWATERMARK esteja definido. Nesse caso, o bitmap de cabeçalho é obtido do membro hbmWatermark . Não há suporte para esse sinalizador em conjunto com PSH_AEROWIZARD. |
| PSH_WIZARD (0x00000020) | Cria uma folha de propriedades do assistente. Ao usar PSH_AEROWIZARD, você também deve definir esse sinalizador. |
| PSH_WIZARD97 (0x01000000) | Versão 5.80. Cria uma folha de propriedades no estilo Wizard97, que dá suporte a bitmaps no cabeçalho de páginas interiores e no lado esquerdo das páginas externas. Não há suporte para esse sinalizador em conjunto com PSH_AEROWIZARD. |
| PSH_WIZARDCONTEXTHELP (0x00001000) | Adiciona um botão de Ajuda contextual ("?"), que geralmente está ausente da barra de legenda de um assistente. Esse sinalizador não é válido para folhas de propriedades regulares. Não há suporte para esse sinalizador em conjunto com PSH_AEROWIZARD. |
| PSH_WIZARDHASFINISH (0x00000010) | Sempre exibe o botão Concluir no assistente. Você também deve definir PSH_WIZARD, PSH_WIZARD97 ou PSH_AEROWIZARD. |
| PSH_WIZARD_LITE (0x00400000) | Versão 5.80. Usa o estilo Wizard-lite. Esse estilo é semelhante à aparência de PSH_WIZARD97, mas é implementado da mesma forma que PSH_WIZARD. Há poucas restrições sobre como as páginas são formatadas. Por exemplo, não há bordas impostas e o estilo PSH_WIZARD_LITE não pinta a marca d'água e os bitmaps de cabeçalho para você da maneira que o Wizard97 faz. Não há suporte para esse sinalizador em conjunto com PSH_AEROWIZARD. |
hwndParent
Digite: HWND
Manipule para a janela de proprietário da folha de propriedades.
hInstance
Tipo: HINSTANCE
Manipule para a instância da qual carregar o ícone, o recurso de cadeia de caracteres de título, o nome da página inicial, o bitmap de cabeçalho ou a marca d'água. Se o membro pszIcon, pszCaption, pStartPage, pszbmHeader ou pszbmWatermark identificar um recurso a ser carregado, esse membro deverá ser especificado.
hIcon
Tipo: HICON
Manipule para o ícone a ser usado como o pequeno ícone na barra de título da caixa de diálogo da folha de propriedades. Esse membro será usado se o membro dwFlags incluir PSH_USEHICON. Esse membro é declarado como uma união com pszIcon.
pszIcon
Tipo: LPCTSTR
Recurso de ícone a ser usado como o pequeno ícone na barra de título da caixa de diálogo da folha de propriedades. Esse membro será usado se o membro dwFlags incluir PSH_USEICONID. Esse membro pode especificar o identificador do recurso de ícone ou o endereço da cadeia de caracteres que especifica o nome do recurso de ícone. Em ambos os casos, o ícone é carregado da instância fornecida pelo membro hInstance . Esse membro é declarado como uma união com hIcon.
pszCaption
Tipo: LPCTSTR
Título da caixa de diálogo da folha de propriedades. Esse membro pode especificar o identificador de um recurso de cadeia de caracteres (carregado da instância especificada pelo membro hInstance ) ou o endereço de uma cadeia de caracteres que especifica o título. Se o membro dwFlags incluir PSH_PROPTITLE, a cadeia de caracteres Propriedades para será inserida no início do título. Esse campo é ignorado para assistentes do Wizard97. Para assistentes aero, a cadeia de caracteres sozinha é usada para o legenda, independentemente de o sinalizador de PSH_PROPTITLE estar definido.
nPages
Tipo: UINT
Número de páginas de folha de propriedades fornecidas na matriz ppsp ou phpage .
nStartPage
Tipo: UINT
Índice baseado em zero da página inicial que aparece quando a caixa de diálogo da folha de propriedades é criada. Esse membro será usado se o membro dwFlags não incluir o sinalizador PSH_USEPSTARTPAGE. Esse membro é declarado como uma união com pStartPage.
pStartPage
Tipo: LPCTSTR
Nome da página inicial que aparece quando a caixa de diálogo da folha de propriedades é criada. Esse membro será usado se o membro dwFlags incluir o sinalizador PSH_USESTARTPAGE. Esse membro pode especificar o identificador de um recurso de cadeia de caracteres (carregado da instância especificada pelo membro hInstance ) ou o endereço de uma cadeia de caracteres que especifica o nome. O nome da página inicial é correspondido às legendas das páginas. Esse membro é declarado como uma união com nStartPage.
ppsp
Tipo: LPCPROPSHEETPAGE
Ponteiro para uma matriz de estruturas PROPSHEETPAGE que definem as páginas na folha de propriedades. Se o membro dwFlags não incluir PSH_PROPSHEETPAGE, esse membro será ignorado. Observe que a estrutura PROPSHEETPAGE é variável de tamanho. Os aplicativos que analisam a matriz apontada pelo ppsp devem levar em conta o tamanho de cada página. Esse membro é declarado como uma união com phpage.
phpage
Tipo: HPROPSHEETPAGE*
Ponteiro para uma matriz de identificadores para as páginas da folha de propriedades. Esse membro será usado se o membro dwFlags não incluir PSH_PROPSHEETPAGE. Cada identificador deve ter sido criado por uma chamada anterior para a função CreatePropertySheetPage . Quando a função PropertySheet retornar, todos os identificadores HPROPSHEETPAGE na matriz phpage terão sido destruídos. Esse membro é declarado como uma união com ppsp.
Pfncallback
Tipo: PFNPROPSHEETCALLBACK
Ponteiro para uma função de retorno de chamada definida pelo aplicativo que é chamada quando determinados eventos ocorrem. Para obter mais informações sobre a função de retorno de chamada, consulte a descrição da função de retorno de chamada PFNPROPSHEETCALLBACK . Se o membro dwFlags não incluir PSH_USECALLBACK, esse membro será ignorado.
Hbmwatermark
Tipo: HBITMAP
Versão 5.80 ou posterior. Manipule para o bitmap de marca d'água. Se o membro dwFlags não incluir PSH_USEHBMWATERMARK, esse membro será ignorado.
pszbmWatermark
Tipo: LPCTSTR
Versão 5.80 ou posterior. Recurso de bitmap a ser usado como marca d'água. Esse membro pode especificar o identificador do recurso bitmap ou o endereço da cadeia de caracteres que especifica o nome do recurso bitmap. Se o membro dwFlags incluir PSH_USEHBMWATERMARK, esse membro será ignorado.
hplWatermark
Tipo: HPALETTE
Versão 5.80 ou posterior. Estrutura HPALETTE usada para desenhar o bitmap de marca d'água e/ou bitmap de cabeçalho. Se o membro dwFlags não incluir PSH_USEHPLWATERMARK, esse membro será ignorado.
hbmHeader
Tipo: HBITMAP
Versão 5.80 ou posterior. Manipule para o bitmap de cabeçalho. Se o membro dwFlags não incluir PSH_USEHBMHEADER, esse membro será ignorado.
pszbmHeader
Tipo: LPCSTR
Versão 5.80 ou posterior. Recurso de bitmap a ser usado como o cabeçalho. Esse membro pode especificar o identificador do recurso bitmap ou o endereço da cadeia de caracteres que especifica o nome do recurso bitmap. Se o membro dwFlags incluir PSH_USEHBMHEADER, esse membro será ignorado.
Comentários
Se o usuário escolher uma configuração como Fontes Grandes, que amplia a caixa de diálogo, a marca d'água pintada nas páginas inicial e final também será ampliada. O tamanho e a posição do bitmap original permanecerão os mesmos. A área adicional será preenchida com a cor do pixel no canto superior esquerdo do bitmap.
Os estilos PSH_WIZARD, PSH_WIZARD97 e PSH_WIZARD_LITE são mutuamente incompatíveis. Apenas um desses sinalizadores de estilo deve ser definido. PSH_AEROWIZARD deve ser combinado com PSH_WIZARD.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows Vista [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows Server 2003 [somente aplicativos da área de trabalho] |
| Cabeçalho | Prsht.h |
| Nomes Unicode e ANSI | PROPSHEETHEADERW (Unicode) e PROPSHEETHEADERA (ANSI) |