Compartir a través de


Clase CSnapInPropertyPageImpl

Esta clase proporciona métodos para implementar un objeto de la página de propiedades de complemento.

Importante

Esta clase y sus miembros no se pueden usar en las aplicaciones que se ejecutan en Windows Runtime.

Sintaxis

CSnapInPropertyPageImpl : public CDialogImplBase

Miembros

Constructores públicos

Nombre Descripción
CSnapInPropertyPageImpl::CSnapInPropertyPageImpl Constructor.

Métodos públicos

Nombre Descripción
CSnapInPropertyPageImpl::CancelToClose Cambia el estado de los botones Aceptar y Cancelar.
CSnapInPropertyPageImpl::Create Inicializa un objeto CSnapInPropertyPageImpl recién creado.
CSnapInPropertyPageImpl::OnApply Lo llama el marco cuando el usuario hace clic en el botón Aplicar ahora al usar una hoja de propiedades de tipo asistente.
CSnapInPropertyPageImpl::OnHelp Lo llama el marco cuando el usuario hace clic en el botón Ayuda al usar una hoja de propiedades de tipo asistente.
CSnapInPropertyPageImpl::OnKillActive Lo llama el marco cuando la página actual deja de estar activa.
CSnapInPropertyPageImpl::OnQueryCancel Lo llama el marco cuando el usuario hace clic en el botón Cancelar y antes de que se haya realizado la cancelación.
CSnapInPropertyPageImpl::OnReset Lo llama el marco cuando el usuario hace clic en el botón Restablecer al usar una hoja de propiedades de tipo asistente.
CSnapInPropertyPageImpl::OnSetActive Lo llama el marco cuando se activa la página actual.
CSnapInPropertyPageImpl::OnWizardBack Lo llama el marco cuando el usuario hace clic en el botón Atrás al usar una hoja de propiedades de tipo asistente.
CSnapInPropertyPageImpl::OnWizardFinish Lo llama el marco cuando el usuario hace clic en el botón Finalizar al usar una hoja de propiedades de tipo asistente.
CSnapInPropertyPageImpl::OnWizardNext Lo llama el marco cuando el usuario hace clic en el botón Siguiente al usar una hoja de propiedades de tipo asistente.
CSnapInPropertyPageImpl::QuerySiblings Reenvía el mensaje actual a todas las páginas de la hoja de propiedades.
CSnapInPropertyPageImpl::SetModified Se llama para activar o desactivar el botón Aplicar ahora.

Miembros de datos públicos

Nombre Descripción
CSnapInPropertyPageImpl::m_psp La estructura PROPSHEETPAGE de Windows que usa el objeto CSnapInPropertyPageImpl.

Comentarios

CSnapInPropertyPageImpl proporciona una implementación básica a un objeto de página de propiedades de complemento. Las características básicas de una página de propiedades de complemento se implementan mediante varias interfaces y tipos de mapa diferentes.

Jerarquía de herencia

CDialogImplBase

CSnapInPropertyPageImpl

Requisitos

Encabezado: atlsnap.h

CSnapInPropertyPageImpl::CancelToClose

A esta función se le llama cuando se ha realizado un cambio irrecuperable en los datos de una página de una hoja de propiedades modal.

void CancelToClose();

Comentarios

Esta función cambiará el botón Aceptar a Cerrar y deshabilitará el botón Cancelar. Este cambio alerta al usuario de que un cambio es permanente y de que no se pueden cancelar las modificaciones.

La función de miembro CancelToClose no hace nada en una hoja de propiedades no modal, porque esa hoja no tiene un botón Cancelar de forma predeterminada.

CSnapInPropertyPageImpl::CSnapInPropertyPageImpl

Construye un objeto CSnapInPropertyPageImpl.

CSnapInPropertyPageImpl(LPCTSTR lpszTitle = NULL);

Parámetros

lpszTitle
[in] Título de la página de propiedades.

Comentarios

Para inicializar la estructura subyacente, llame a CSnapInPropertyPageImpl::Create.

CSnapInPropertyPageImpl::Create

Llame a esta función para inicializar la estructura subyacente de la página de propiedades.

HPROPSHEETPAGE Create();

Valor devuelto

Identificador de una estructura PROPSHEETPAGE que contiene los atributos de la hoja de propiedades recién creada.

Comentarios

Antes de llamar a esta función debe llamar a CSnapInPropertyPageImpl::CSnapInPropertyPageImpl.

CSnapInPropertyPageImpl::m_psp

m_psp es una estructura cuyos miembros almacenan las características de PROPSHEETPAGE.

PROPSHEETPAGE m_psp;

Comentarios

Utilice esta estructura para inicializar la apariencia de una página de propiedades después de construirla.

Para más información sobre esta estructura, lo que incluye una lista de sus miembros, consulte PROPSHEETPAGE en Windows SDK.

CSnapInPropertyPageImpl::OnApply

Se llama a esta función miembro cuando el usuario hace clic en los botones Aceptar o Aplicar ahora.

BOOL OnApply();

Valor devuelto

Distinto de cero si se aceptan los cambios; de lo contrario, 0.

Comentarios

Antes de que el marco pueda llamar a OnApply, debe haber llamado a SetModified y establecer su parámetro en TRUE. Esto activará el botón Aplicar ahora en cuanto el usuario realice cualquier cambio en la página de propiedades.

Invalide esta función miembro para especificar la acción que realiza el programa cuando el usuario hace clic en el botón Aplicar ahora. Al realizar el reemplazo, la función debe devolver TRUE para aceptar los cambios y FALSE para evitar que los cambios surtan efecto.

La implementación predeterminada de OnApply devuelve TRUE.

CSnapInPropertyPageImpl::OnHelp

Se llama a esta función miembro cuando el usuario hace clic en el botón Ayuda de la página de propiedades.

void OnHelp();

Comentarios

Invalide esta función miembro para mostrar la ayuda de la página de propiedades.

CSnapInPropertyPageImpl::OnKillActive

Se llama a esta función miembro cuando la página ya no es la página activa.

BOOL OnKillActive();

Valor devuelto

Distinto de cero si los datos se actualizaron correctamente; de lo contrario, 0.

Comentarios

Invalide esta función miembro para realizar tareas especiales de validación de datos.

CSnapInPropertyPageImpl::OnQueryCancel

Se llama a esta función miembro cuando el usuario hace clic en el botón Cancelar y antes de que se haya realizado la acción de cancelación.

BOOL OnQueryCancel();

Valor devuelto

Distinto de cero para permitir la operación de cancelación; de lo contrario, 0.

Comentarios

Invalide esta función miembro para especificar la acción que realiza el programa cuando el usuario hace clic en el botón Cancelar.

La implementación predeterminada de OnQueryCancel devuelve TRUE.

CSnapInPropertyPageImpl::OnReset

Se llama a esta función miembro cuando el usuario hace clic en el botón Cancelar.

void OnReset();

Comentarios

Cuando se llama a esta función, se descartan los cambios realizados en todas las páginas de propiedades realizadas por el usuario antes de hacer clic en el botón Aplicar ahora y la hoja de propiedades conserva el foco.

Invalide esta función miembro para especificar la acción que realiza el programa cuando el usuario hace clic en el botón Cancelar.

CSnapInPropertyPageImpl::OnSetActive

Se llama a esta función miembro cuando el usuario elige la página y esta convierte en la página activa.

BOOL OnSetActive();

Valor devuelto

Distinto de cero si la página se estableció correctamente como activa; de lo contrario, 0.

Comentarios

Invalide esta función miembro para realizar tareas cuando se activa una página. La invalidación de esta función miembro debe llamar a la versión predeterminada antes de que se realice cualquier otro procesamiento.

La implementación predeterminada devuelve TRUE.

CSnapInPropertyPageImpl::OnWizardBack

Se llama a esta función miembro cuando el usuario hace clic en el botón Atrás en un asistente.

BOOL OnWizardBack();

Valor devuelto

  • 0 para ir automáticamente a la página anterior.

  • -1 para evitar que la página cambie.

Para ir a cualquier página, salvo a la siguiente, devuelva el identificador del cuadro de diálogo que se va a mostrar.

Comentarios

Invalide esta función miembro para especificar la acción que el usuario debe realizar cuando se haga clic en el botón Atrás.

CSnapInPropertyPageImpl::OnWizardFinish

Se llama a esta función miembro cuando el usuario hace clic en el botón Finalizar en un asistente.

BOOL OnWizardFinish();

Valor devuelto

Distinto de cero si la hoja de propiedades se destruye cuando finaliza el asistente; de lo contrario, cero.

Comentarios

Invalide esta función miembro para especificar la acción que el usuario debe realizar cuando se haga clic en el botón Finalizar.

CSnapInPropertyPageImpl::OnWizardNext

Se llama a esta función miembro cuando el usuario hace clic en el botón Siguiente en un asistente.

BOOL OnWizardNext();

Valor devuelto

  • 0 para pasar automáticamente a la página siguiente.

  • -1 para evitar que la página cambie.

Para ir a cualquier página, salvo a la siguiente, devuelva el identificador del cuadro de diálogo que se va a mostrar.

Comentarios

Invalide esta función miembro para especificar la acción que el usuario debe realizar cuando se haga clic en el botón Siguiente.

CSnapInPropertyPageImpl::QuerySiblings

Llame a esta función miembro para reenviar un mensaje a cada página de la hoja de propiedades.

LRESULT QuerySiblings(WPARAM wParam, LPARAM lParam);

Parámetros

wParam
[in] Proporciona información adicional que depende del mensaje.

lParam
[in] Proporciona información adicional que depende del mensaje.

Valor devuelto

Distinto de cero si el mensaje no se debe reenviar a la página de propiedades siguiente; de lo contrario, cero.

Comentarios

Si una página devuelve un valor distinto de cero, la hoja de propiedades no envía el mensaje a las páginas posteriores.

CSnapInPropertyPageImpl::SetModified

Llame a esta función miembro para habilitar o deshabilitar el botón Aplicar ahora, con base en si la configuración de la página de propiedades se debe aplicar al objeto externo adecuado.

void SetModified(BOOL bChanged = TRUE);

Parámetros

bChanged
[in] TRUE para indicar que la configuración de la página de propiedades se ha modificado desde la última vez que se aplicaron; FALSE para indicar que la configuración de la página de propiedades se ha aplicado o se debe omitir.

Comentarios

La hoja de propiedades realiza un seguimiento de cuáles son las páginas "sucias", es decir, las páginas de propiedades para las que se ha llamado a SetModified( TRUE ). El botón Aplicar ahora siempre se habilitará si se llama a SetModified( TRUE ) para una de las páginas. El botón Aplicar ahora se deshabilitará cuando llame a SetModified( FALSE ) en una de las páginas, pero solo si ninguna de las otras páginas está "sucia".

Consulte también

Información general sobre la clase