Compartilhar via

Estrutura PROPSHEETPAGE

  • Artigo

Define uma página em uma folha de propriedades.

Sintaxe

typedef struct {
    DWORD      dwSize;
    DWORD      dwFlags;
    HINSTANCE  hInstance;
    union {
        LPCSTR                 pszTemplate;
        PROPSHEETPAGE_RESOURCE pResource;
    };
    union {
        HICON  hIcon;
        LPCSTR pszIcon;
    };
    LPCSTR          pszTitle;
    DLGPROC         pfnDlgProc;
    LPARAM          lParam;
    LPFNPSPCALLBACK pfnCallback;
    UINT            *pcRefParent;
    LPCTSTR         pszHeaderTitle;
    LPCTSTR         pszHeaderSubTitle;
    HANDLE          hActCtx;
    union 
    {
        HBITMAP     hbmHeader;
        LPCSTR      pszbmHeader;
    }
} PROPSHEETPAGE, *LPPROPSHEETPAGE;

Membros

dwSize

Tipo: DWORD

Tamanho, em bytes, dessa estrutura.

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
PSP_DEFAULT Usa o significado padrão para todos os membros da estrutura. Não há suporte para esse sinalizador ao usar o assistente de estilo Aero (PSH_AEROWIZARD).
PSP_DLGINDIRECT Cria a página do modelo da caixa de diálogo na memória apontada pelo membro pResource . A função PropertySheet pressupõe que o modelo que está na memória não esteja protegido por gravação. Um modelo somente leitura causará uma exceção em algumas versões do Windows.
PSP_HASHELP Habilita o botão Ajuda da folha de propriedades quando a página está ativa. Não há suporte para esse sinalizador ao usar o assistente de estilo Aero (PSH_AEROWIZARD).
PSP_HIDEHEADER Versão 5.80 e posterior. Faz com que a folha de propriedades do assistente oculte a área de cabeçalho quando a página é selecionada. Se uma marca d'água tiver sido fornecida, ela será pintada no lado esquerdo da página. Esse sinalizador deve ser definido para páginas de boas-vindas e de conclusão e omitido para páginas internas. Não há suporte para esse sinalizador ao usar o assistente de estilo Aero (PSH_AEROWIZARD).
PSP_PREMATURE Versão 4.71 ou posterior. Faz com que a página seja criada quando a folha de propriedades é criada. Se esse sinalizador não for especificado, a página não será criada até que seja selecionada pela primeira vez. Não há suporte para esse sinalizador ao usar o assistente de estilo Aero (PSH_AEROWIZARD).
PSP_RTLREADING Inverte a direção na qual pszTitle é exibido. Janelas normais exibem todo o texto, incluindo pszTitle, LTR (esquerda para direita). Para idiomas como hebraico ou árabe que leem da direita para a esquerda (RTL), uma janela pode ser espelhada e todo o texto será exibido RTL. Se PSP_RTLREADING estiver definido, pszTitle lerá RTL em uma janela pai normal e LTR em uma janela pai espelhada.
PSP_USECALLBACK Chama a função especificada pelo membro pfnCallback ao criar ou destruir a página da folha de propriedades definida por essa estrutura.
PSP_USEFUSIONCONTEXT Versão 6.0 e posterior. Use um contexto de ativação. Para usar um contexto de ativação, você deve definir esse sinalizador e atribuir o identificador de contexto de ativação ao hActCtx. Confira os Comentários.
PSP_USEHEADERSUBTITLE Versão 5.80 ou posterior. Exibe a cadeia de caracteres apontada pelo membro pszHeaderSubTitle como o subtítulo da área de cabeçalho de uma página do Wizard97. Para usar esse sinalizador, você também deve definir o sinalizador PSH_WIZARD97 no membro dwFlags da estrutura PROPSHEETHEADER associada. O sinalizador PSP_USEHEADERSUBTITLE será ignorado se PSP_HIDEHEADER estiver definido. Em assistentes de estilo aero, o título aparece próximo à parte superior da área do cliente.
PSP_USEHEADERTITLE Versão 5.80 ou posterior. Exibe a cadeia de caracteres apontada pelo membro pszHeaderTitle como o título no cabeçalho de uma página interior do Wizard97. Você também deve definir o sinalizador PSH_WIZARD97 no membro dwFlags da estrutura PROPSHEETHEADER associada. O sinalizador PSP_USEHEADERTITLE será ignorado se PSP_HIDEHEADER estiver definido. Não há suporte para esse sinalizador ao usar o assistente de estilo Aero (PSH_AEROWIZARD).
PSP_USEHICON Usa hIcon como o ícone pequeno na guia da página. Não há suporte para esse sinalizador ao usar o assistente de estilo Aero (PSH_AEROWIZARD).
PSP_USEICONID Usa pszIcon como o nome do recurso de ícone para carregar e usar como o pequeno ícone na guia da página. Não há suporte para esse sinalizador ao usar o assistente de estilo Aero (PSH_AEROWIZARD).
PSP_USEREFPARENT Mantém a contagem de referência especificada pelo membro pcRefParent para o tempo de vida da página da folha de propriedades criada a partir dessa estrutura.
PSP_USETITLE Usa o membro pszTitle como o título da caixa de diálogo da folha de propriedades em vez do título armazenado no modelo da caixa de diálogo. Não há suporte para esse sinalizador ao usar o assistente de estilo Aero (PSH_AEROWIZARD).

hInstance

Tipo: HINSTANCE

Manipule para a instância da qual carregar um ícone ou recurso de cadeia de caracteres. Se o membro pszIcon, pszTitle, pszHeaderTitle ou pszHeaderSubTitle identificar um recurso a ser carregado, hInstance deverá ser especificado.

pszTemplate

Tipo: LPCSTR

Modelo de caixa de diálogo a ser usado para criar a página. Esse membro pode especificar o identificador de recurso do modelo ou o endereço de uma cadeia de caracteres que especifica o nome do modelo. Se o sinalizador PSP_DLGINDIRECT no membro dwFlags estiver definido, pszTemplate será ignorado. Esse membro é declarado como uma união com pResource.

pResource

Tipo: LPCDLGTEMPLATE

Ponteiro para um modelo de caixa de diálogo na memória. A função PropertySheet pressupõe que o modelo não esteja protegido por gravação. Um modelo somente leitura causará uma exceção em algumas versões do Windows. Para usar esse membro, você deve definir o sinalizador PSP_DLGINDIRECT no membro dwFlags . Esse membro é declarado como uma união com pszTemplate.

hIcon

Tipo: HICON

Manipule para o ícone a ser usado como o ícone na guia da página. Se o membro dwFlags não incluir PSP_USEHICON, esse membro será ignorado. Esse membro é declarado como uma união com pszIcon.

pszIcon

Tipo: LPCSTR

Recurso de ícone a ser usado como o ícone na guia da página. 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. Para usar esse membro, você deve definir o sinalizador PSP_USEICONID no membro dwFlags . Esse membro é declarado como uma união com hIcon.

Psztitle

Tipo: LPCSTR

Título da caixa de diálogo da folha de propriedades. Esse título substitui o título especificado no modelo da caixa de diálogo. Esse membro pode especificar o identificador de um recurso de cadeia de caracteres ou o endereço de uma cadeia de caracteres que especifica o título. Para usar esse membro, você deve definir o sinalizador PSP_USETITLE no membro dwFlags .

pfnDlgProc

Tipo: DLGPROC

Ponteiro para o procedimento da caixa de diálogo da página. Como as páginas são criadas como caixas de diálogo sem formação, o procedimento da caixa de diálogo não deve chamar a função EndDialog .

lParam

Tipo: LPARAM

Quando a página é criada, uma cópia da estrutura PROPSHEETPAGE da página é passada para o procedimento da caixa de diálogo com uma mensagem WM_INITDIALOG . O membro lParam é fornecido para permitir que você passe informações específicas do aplicativo para o procedimento da caixa de diálogo. Ele não tem nenhum efeito na própria página.

Pfncallback

Tipo: LPFNPSPCALLBACK

Ponteiro para uma função de retorno de chamada definida pelo aplicativo que é chamada quando a página é criada e quando ela está prestes a ser destruída. Para obter mais informações sobre a função de retorno de chamada, consulte Função de retorno de chamada LPFNPSPCALLBACKA. Para usar esse membro, você deve definir o sinalizador PSP_USECALLBACK no membro dwFlags .

pcRefParent

Tipo: UINT*

Ponteiro para o valor da contagem de referência. Para usar esse membro, você deve definir o sinalizador PSP_USEREFPARENT no membro dwFlags .

Observação

Quando uma página de folha de propriedades é criada, o valor apontado por pcRefParent é incrementado. Você cria uma página de folha de propriedades implicitamente definindo o sinalizador PSH_PROPSHEETPAGE no membro dwFlags de PROPSHEETHEADER e chamando a função PropertySheet . Você pode fazer isso explicitamente usando a função CreatePropertySheetPage . Quando uma página de folha de propriedades é destruída, o valor apontado pelo membro pcRefParent é decrementado. Isso ocorre automaticamente quando a folha de propriedades é destruída. Você pode destruir explicitamente uma página de folha de propriedades usando a função DestroyPropertySheetPage .

pszHeaderTitle

Tipo: LPCTSTR

Versão 5.80 ou posterior. Título da área de cabeçalho. Para usar esse membro no assistente de estilo Wizard97, você também deve fazer o seguinte:

  • Defina o sinalizador PSP_USEHEADERTITLE no membro dwFlags .
  • Defina o sinalizador PSH_WIZARD97 no membro dwFlags da estrutura PROPSHEETHEADER da página.
  • Verifique se o sinalizador PSP_HIDEHEADER no membro dwFlags não está definido.

pszHeaderSubTitle

Tipo: LPCTSTR

Versão 5.80 ou posterior. Subtítulo da área de cabeçalho. Para usar esse membro, você deve fazer o seguinte:

  • Defina o sinalizador PSP_USEHEADERSUBTITLE no membro dwFlags .
  • Defina o sinalizador PSH_WIZARD97 no membro dwFlags da estrutura PROPSHEETHEADER da página.
  • Verifique se o sinalizador PSP_HIDEHEADER no membro dwFlags não está definido.

Observação

Esse membro é ignorado ao usar o assistente de estilo Aero (PSH_AEROWIZARD)

hActCtx

Tipo: HANDLE

Versão 6.0 ou posterior. Um identificador de contexto de ativação. Defina esse membro como o identificador que é retornado quando você cria o contexto de ativação com CreateActCtx. O sistema ativará esse contexto antes de criar a caixa de diálogo. Você não precisará usar esse membro se usar um manifesto global.

hbmHeader

Tipo: HBITMAP

Esse membro é declarado como uma união com pszbmHeader.

pszbmHeader

Tipo: LPCSTR

Esse membro é declarado como uma união com hbmHeader.

Comentários

Comctl32.dll versão 6 e posteriores não são redistribuíveis. Para usar Comctl32.dll versão 6 ou posterior, especifique o arquivo .dll em um manifesto. Para obter mais informações sobre manifestos, consulte Habilitando estilos visuais.

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)