Classe CSnapInPropertyPageImpl
Essa classe fornece métodos para implementar um objeto da página de propriedades snap-in.
Importante
Essa classe e os respectivos membros não podem ser usados em aplicativos executados no Windows Runtime.
Sintaxe
CSnapInPropertyPageImpl : public CDialogImplBase
Membros
Construtores públicos
| Nome | Descrição |
|---|---|
| CSnapInPropertyPageImpl::CSnapInPropertyPageImpl | Construtor. |
Métodos públicos
| Nome | Descrição |
|---|---|
| CSnapInPropertyPageImpl::CancelToClose | Altera o status dos botões OK e Cancelar. |
| CSnapInPropertyPageImpl::Create | Inicializa um objeto CSnapInPropertyPageImpl recém-criado. |
| CSnapInPropertyPageImpl::OnApply | Chamado pela estrutura quando o usuário clica no botão Aplicar Agora usando uma folha de propriedades do tipo assistente. |
| CSnapInPropertyPageImpl::OnHelp | Chamado pela estrutura quando o usuário clica no botão Ajuda ao usar uma folha de propriedades do tipo assistente. |
| CSnapInPropertyPageImpl::OnKillActive | Chamado pela estrutura quando a página atual não está mais ativa. |
| CSnapInPropertyPageImpl::OnQueryCancel | Chamado pela estrutura quando o usuário clica no botão Cancelar e antes do cancelamento ocorrer. |
| CSnapInPropertyPageImpl::OnReset | Chamado pela estrutura quando o usuário clica no botão Redefinir usando uma folha de propriedades do tipo assistente. |
| CSnapInPropertyPageImpl::OnSetActive | Chamado pela estrutura quando a página atual se torna ativa. |
| CSnapInPropertyPageImpl::OnWizardBack | Chamado pela estrutura quando o usuário clica no botão Voltar usando uma folha de propriedades do tipo assistente. |
| CSnapInPropertyPageImpl::OnWizardFinish | Chamado pela estrutura quando o usuário clica no botão Concluir usando uma folha de propriedades do tipo assistente. |
| CSnapInPropertyPageImpl::OnWizardNext | Chamado pela estrutura quando o usuário clica no botão Avançar usando uma folha de propriedades do tipo assistente. |
| CSnapInPropertyPageImpl::QuerySiblings | Encaminha a mensagem atual para todas as páginas da folha de propriedades. |
| CSnapInPropertyPageImpl::SetModified | Chame para ativar ou desativar o botão Aplicar Agora. |
Membros de Dados Públicos
| Nome | Descrição |
|---|---|
| CSnapInPropertyPageImpl::m_psp | A estrutura do Windows PROPSHEETPAGE usada pelo objeto CSnapInPropertyPageImpl. |
Comentários
CSnapInPropertyPageImpl fornece uma implementação básica para um objeto de página de propriedade snap-in. Os recursos básicos de uma página de propriedade snap-in são implementados usando várias interfaces e tipos de mapa diferentes.
Hierarquia de herança
CDialogImplBase
CSnapInPropertyPageImpl
Requisitos
Cabeçalho: atlsnap.h
CSnapInPropertyPageImpl::CancelToClose
Chame esta função depois que uma alteração irrecuperável for feita nos dados em uma página de uma folha de propriedades modal.
void CancelToClose();
Comentários
Esta função alterará o botão OK para Fechar e desabilitará o botão Cancelar. Essa alteração alertará o usuário de que uma alteração tornou-se permanente e as modificações não poderão ser canceladas.
A função membro CancelToClose não faz nada em uma folha de propriedades de modeless, porque uma folha de propriedades modeless não tem um botão Cancelar por padrão.
CSnapInPropertyPageImpl::CSnapInPropertyPageImpl
Constrói um objeto CSnapInPropertyPageImpl.
CSnapInPropertyPageImpl(LPCTSTR lpszTitle = NULL);
Parâmetros
lpszTitle
[in] O título da página de propriedades.
Comentários
Para inicializar a estrutura subjacente, chame CSnapInPropertyPageImpl::Create.
CSnapInPropertyPageImpl::Create
Chame essa função para inicializar a estrutura subjacente da página de propriedades.
HPROPSHEETPAGE Create();
Valor de retorno
Um identificador para uma estrutura PROPSHEETPAGE, que contém os atributos da folha de propriedades recém-criada.
Comentários
Primeiro, você deve chamar CSnapInPropertyPageImpl::CSnapInPropertyPageImpl antes de chamar essa função.
CSnapInPropertyPageImpl::m_psp
m_psp é uma estrutura cujos membros armazenam as características de PROPSHEETPAGE.
PROPSHEETPAGE m_psp;
Comentários
Use essa estrutura para inicializar a aparência de uma página de propriedade depois que ela for construída.
Para obter mais informações sobre essa estrutura, incluindo uma listagem de seus membros, consulte PROPSHEETPAGE no SDK do Windows.
CSnapInPropertyPageImpl::OnApply
Essa função membro é chamada quando o usuário clica no botão OK ou Aplicar Agora.
BOOL OnApply();
Valor de retorno
Será diferente de zero se as alterações forem aceitas; caso contrário, 0.
Comentários
Antes OnApply de poder ser chamado pela estrutura, você deve ter chamado SetModified e definido seu parâmetro como TRUE. Isso ativará o botão Aplicar agora assim que o usuário fizer uma alteração na página de propriedades.
Substitua essa função de membro para especificar qual ação seu programa toma quando o usuário clica no botão Aplicar Agora. Ao ser substituída, a função deve retornar TRUE para aceitar alterações e FALSE para impedir que as alterações entrem em vigor.
A implementação padrão de OnApply retorna TRUE.
CSnapInPropertyPageImpl::OnHelp
Essa função membro é chamada quando o usuário clica no botão Ajuda da página de propriedades.
void OnHelp();
Comentários
Substitua essa função de membro para exibir a ajuda da página de propriedades.
CSnapInPropertyPageImpl::OnKillActive
Essa função membro é chamada quando a página não for mais a página ativa.
BOOL OnKillActive();
Valor de retorno
Diferente de zero se os dados foram atualizados com êxito; caso contrário, 0.
Comentários
Substitua essa função de membro para executar tarefas especiais de validação de dados.
CSnapInPropertyPageImpl::OnQueryCancel
Essa função membro é chamada quando o usuário clica no botão Cancelar e antes da ação de cancelamento ocorrer.
BOOL OnQueryCancel();
Valor de retorno
Diferente de zero para permitir a operação de cancelamento; caso contrário, 0.
Comentários
Substitua essa função de membro para especificar uma ação que o programa executa quando o usuário clica no botão Cancelar.
A implementação padrão de OnQueryCancel retorna TRUE.
CSnapInPropertyPageImpl::OnReset
Essa função membro é chamada quando o usuário clica no botão Cancelar.
void OnReset();
Comentários
Quando essa função é chamada, as alterações em todas as páginas de propriedades que foram feitas pelo usuário anteriormente clicando no botão Aplicar Agora serão descartadas e a folha de propriedades manterá o foco.
Substitua essa função membro para especificar a ação que o programa executará quando o usuário clicar no botão Cancelar.
CSnapInPropertyPageImpl::OnSetActive
Essa função membro é chamada quando a página é escolhida pelo usuário e se torna a página ativa.
BOOL OnSetActive();
Valor de retorno
Diferente de zero se a página foi definida como ativa com êxito; caso contrário, 0.
Comentários
Substitua essa função de membro para executar tarefas quando uma página for ativada. Sua substituição dessa função membro deverá chamar a versão padrão antes que qualquer outro processamento seja feito.
A implementação padrão retorna TRUE.
CSnapInPropertyPageImpl::OnWizardBack
Essa função membro é chamada quando o usuário clica no botão Voltar em um assistente.
BOOL OnWizardBack();
Valor de retorno
0 para avançar automaticamente para a página anterior.
-1 para impedir que a página seja alterada.
Para ir para uma página diferente da próxima, retorne o identificador da caixa de diálogo a ser exibida.
Comentários
Substitua essa função de membro para especificar alguma ação que o usuário deve executar quando o botão Voltar for clicado.
CSnapInPropertyPageImpl::OnWizardFinish
Essa função membro é chamada quando o usuário clica no botão Concluir em um assistente.
BOOL OnWizardFinish();
Valor de retorno
Diferente de zero se a folha de propriedades for destruída quando o assistente for concluído; caso contrário, zero.
Comentários
Substitua essa função membro para especificar alguma ação que o usuário deve executar quando o botão Concluir for clicado.
CSnapInPropertyPageImpl::OnWizardNext
Essa função membro é chamada quando o usuário clica no botão Avançar em um assistente.
BOOL OnWizardNext();
Valor de retorno
0 para avançar automaticamente para a próxima página.
-1 para impedir que a página seja alterada.
Para ir para uma página diferente da próxima, retorne o identificador da caixa de diálogo a ser exibida.
Comentários
Substitua essa função membro para especificar alguma ação que o usuário deverá executar quando o botão Avançar for clicado.
CSnapInPropertyPageImpl::QuerySiblings
Chame essa função membro para encaminhar uma mensagem para cada página na folha de propriedades.
LRESULT QuerySiblings(WPARAM wParam, LPARAM lParam);
Parâmetros
wParam
[in] Especifica informações adicionais dependentes de mensagens.
lParam
[in] Especifica informações adicionais dependentes de mensagens.
Valor de retorno
Diferente de zero se a mensagem não deve ser encaminhada para a próxima página de propriedades; caso contrário, zero.
Comentários
Se uma página retornar um valor não zero, a folha de propriedades não enviará a mensagem para páginas subsequentes.
CSnapInPropertyPageImpl::SetModified
Chame essa função de membro para habilitar ou desabilitar o botão Aplicar agora, com base em se as configurações na página de propriedade devem ser aplicadas ao objeto externo apropriado.
void SetModified(BOOL bChanged = TRUE);
Parâmetros
bChanged
[in] TRUE para indicar que as configurações da página de propriedade foram modificadas desde a última vez em que foram aplicadas; FALSE para indicar que as configurações da página de propriedade foram aplicadas ou devem ser ignoradas.
Comentários
A folha de propriedades mantém o controle de quais páginas são "sujas", ou seja, páginas de propriedade para as quais você chamou SetModified( TRUE ). O botão Aplicar Agora sempre será habilitado se você chamar SetModified( TRUE ) para uma das páginas. O botão Aplicar Agora será desabilitado quando você chamar SetModified( FALSE ) para uma das páginas, mas, somente se nenhuma das outras páginas estiver "suja".