CSnapInPropertyPageImpl, classe
Cette classe fournit des méthodes pour implémenter un objet de page de propriétés enfichable.
Important
Cette classe et ses membres ne peuvent pas être utilisés dans les applications qui s’exécutent dans Windows Runtime.
Syntaxe
CSnapInPropertyPageImpl : public CDialogImplBase
Membres
Constructeurs publics
| Nom | Description |
|---|---|
| CSnapInPropertyPageImpl ::CSnapInPropertyPageImpl | Constructeur. |
Méthodes publiques
| Nom | Description |
|---|---|
| CSnapInPropertyPageImpl ::CancelToClose | Modifie l’état des boutons OK et Annuler . |
| CSnapInPropertyPageImpl ::Create | Initialise un objet nouvellement créé CSnapInPropertyPageImpl . |
| CSnapInPropertyPageImpl ::OnApply | Appelé par l’infrastructure lorsque l’utilisateur clique sur le bouton Appliquer maintenant lors de l’utilisation d’une feuille de propriétés de type Assistant. |
| CSnapInPropertyPageImpl ::OnHelp | Appelé par l’infrastructure lorsque l’utilisateur clique sur le bouton Aide lors de l’utilisation d’une feuille de propriétés de type Assistant. |
| CSnapInPropertyPageImpl ::OnKillActive | Appelé par l’infrastructure lorsque la page active n’est plus active. |
| CSnapInPropertyPageImpl ::OnQueryCancel | Appelé par l’infrastructure lorsque l’utilisateur clique sur le bouton Annuler et avant que l’annulation ait eu lieu. |
| CSnapInPropertyPageImpl ::OnReset | Appelé par l’infrastructure lorsque l’utilisateur clique sur le bouton Réinitialiser lors de l’utilisation d’une feuille de propriétés de type Assistant. |
| CSnapInPropertyPageImpl ::OnSetActive | Appelé par l’infrastructure lorsque la page active devient active. |
| CSnapInPropertyPageImpl ::OnWizardBack | Appelé par l’infrastructure lorsque l’utilisateur clique sur le bouton Précédent lors de l’utilisation d’une feuille de propriétés de type Assistant. |
| CSnapInPropertyPageImpl ::OnWizardFinish | Appelé par l’infrastructure lorsque l’utilisateur clique sur le bouton Terminer lors de l’utilisation d’une feuille de propriétés de type Assistant. |
| CSnapInPropertyPageImpl ::OnWizardNext | Appelé par l’infrastructure lorsque l’utilisateur clique sur le bouton Suivant lors de l’utilisation d’une feuille de propriétés de type Assistant. |
| CSnapInPropertyPageImpl ::QuerySiblings | Transfère le message actuel à toutes les pages de la feuille de propriétés. |
| CSnapInPropertyPageImpl ::SetModified | Appelez pour activer ou désactiver le bouton Appliquer maintenant . |
Membres de données publics
| Nom | Description |
|---|---|
| CSnapInPropertyPageImpl ::m_psp | Structure Windows PROPSHEETPAGE utilisée par l’objet CSnapInPropertyPageImpl . |
Notes
CSnapInPropertyPageImpl fournit une implémentation de base pour un objet de page de propriétés enfichable. Les fonctionnalités de base d’une page de propriétés de composant logiciel enfichable sont implémentées à l’aide de plusieurs interfaces et types de mappage différents.
Hiérarchie d'héritage
CDialogImplBase
CSnapInPropertyPageImpl
Spécifications
En-tête : atlsnap.h
CSnapInPropertyPageImpl ::CancelToClose
Appelez cette fonction une fois qu’une modification irrécupérable a été apportée aux données dans une page d’une feuille de propriétés modale.
void CancelToClose();
Notes
Cette fonction modifie le bouton OK pour fermer et désactiver le bouton Annuler . Cette modification avertit l’utilisateur qu’une modification est permanente et que les modifications ne peuvent pas être annulées.
La CancelToClose fonction membre ne fait rien dans une feuille de propriétés sans mode, car une feuille de propriétés sans mode n’a pas de bouton Annuler par défaut.
CSnapInPropertyPageImpl ::CSnapInPropertyPageImpl
Construit un objet CSnapInPropertyPageImpl.
CSnapInPropertyPageImpl(LPCTSTR lpszTitle = NULL);
Paramètres
lpszTitle
[in] Titre de la page de propriétés.
Notes
Pour initialiser la structure sous-jacente, appelez CSnapInPropertyPageImpl ::Create.
CSnapInPropertyPageImpl ::Create
Appelez cette fonction pour initialiser la structure sous-jacente de la page de propriétés.
HPROPSHEETPAGE Create();
Valeur de retour
Handle vers une PROPSHEETPAGE structure contenant les attributs de la feuille de propriétés nouvellement créée.
Notes
Vous devez d’abord appeler CSnapInPropertyPageImpl ::CSnapInPropertyPageImpl avant d’appeler cette fonction.
CSnapInPropertyPageImpl ::m_psp
m_pspest une structure dont les membres stockent les caractéristiques .PROPSHEETPAGE
PROPSHEETPAGE m_psp;
Notes
Utilisez cette structure pour initialiser l’apparence d’une page de propriétés après sa construction.
Pour plus d’informations sur cette structure, notamment une liste de ses membres, consultez PROPSHEETPAGE dans le Kit de développement logiciel (SDK) Windows.
CSnapInPropertyPageImpl ::OnApply
Cette fonction membre est appelée lorsque l’utilisateur clique sur le OK ou le bouton Appliquer maintenant.
BOOL OnApply();
Valeur de retour
Différent de zéro si les modifications sont acceptées ; sinon 0.
Notes
Avant OnApply de pouvoir être appelé par l’infrastructure, vous devez avoir appelé SetModified et définir son paramètre sur TRUE. Cela active le bouton Appliquer maintenant dès que l’utilisateur apporte une modification à la page de propriétés.
Remplacez cette fonction membre pour spécifier l’action que votre programme effectue lorsque l’utilisateur clique sur le bouton Appliquer maintenant . En cas de substitution, la fonction doit retourner TRUE pour accepter les modifications et FALSE afin d’empêcher les modifications de prendre effet.
Implémentation par défaut de OnApply retour TRUE.
CSnapInPropertyPageImpl ::OnHelp
Cette fonction membre est appelée lorsque l’utilisateur clique sur le bouton Aide de la page de propriétés.
void OnHelp();
Notes
Remplacez cette fonction membre pour afficher l’aide de la page de propriétés.
CSnapInPropertyPageImpl ::OnKillActive
Cette fonction membre est appelée lorsque la page n’est plus la page active.
BOOL OnKillActive();
Valeur de retour
Différent de zéro si les données ont été mises à jour avec succès ; sinon 0.
Notes
Remplacez cette fonction membre pour effectuer des tâches de validation de données spéciales.
CSnapInPropertyPageImpl ::OnQueryCancel
Cette fonction membre est appelée lorsque l’utilisateur clique sur le bouton Annuler et avant que l’action d’annulation ait eu lieu.
BOOL OnQueryCancel();
Valeur de retour
Non différent de zéro pour autoriser l’opération d’annulation ; sinon 0.
Notes
Remplacez cette fonction membre pour spécifier une action effectuée par le programme lorsque l’utilisateur clique sur le bouton Annuler .
Implémentation par défaut de OnQueryCancel retour TRUE.
CSnapInPropertyPageImpl ::OnReset
Cette fonction membre est appelée lorsque l’utilisateur clique sur le bouton Annuler .
void OnReset();
Notes
Lorsque cette fonction est appelée, les modifications apportées à toutes les pages de propriétés effectuées par l’utilisateur en cliquant précédemment sur le bouton Appliquer maintenant sont ignorées et la feuille de propriétés conserve le focus.
Remplacez cette fonction membre pour spécifier l’action effectuée par le programme lorsque l’utilisateur clique sur le bouton Annuler .
CSnapInPropertyPageImpl ::OnSetActive
Cette fonction membre est appelée lorsque la page est choisie par l’utilisateur et devient la page active.
BOOL OnSetActive();
Valeur de retour
Différent de zéro si la page a été correctement définie ; sinon 0.
Notes
Remplacez cette fonction membre pour effectuer des tâches lorsqu’une page est activée. Votre remplacement de cette fonction membre doit appeler la version par défaut avant tout autre traitement.
L’implémentation par défaut retourne TRUE.
CSnapInPropertyPageImpl ::OnWizardBack
Cette fonction membre est appelée lorsque l’utilisateur clique sur le bouton Précédent dans un Assistant.
BOOL OnWizardBack();
Valeur de retour
0 pour passer automatiquement à la page précédente.
-1 pour empêcher la modification de la page.
Pour accéder à une page autre que la suivante, retournez l’identificateur de la boîte de dialogue à afficher.
Notes
Remplacez cette fonction membre pour spécifier une action que l’utilisateur doit effectuer lorsque le bouton Précédent est cliqué.
CSnapInPropertyPageImpl ::OnWizardFinish
Cette fonction membre est appelée lorsque l’utilisateur clique sur le bouton Terminer dans un Assistant.
BOOL OnWizardFinish();
Valeur de retour
Différent de zéro si la feuille de propriétés est détruite lorsque l’Assistant se termine ; sinon zéro.
Notes
Remplacez cette fonction membre pour spécifier une action que l’utilisateur doit effectuer lorsque le bouton Terminer est cliqué.
CSnapInPropertyPageImpl ::OnWizardNext
Cette fonction membre est appelée lorsque l’utilisateur clique sur le bouton Suivant dans un Assistant.
BOOL OnWizardNext();
Valeur de retour
0 pour passer automatiquement à la page suivante.
-1 pour empêcher la modification de la page.
Pour accéder à une page autre que la suivante, retournez l’identificateur de la boîte de dialogue à afficher.
Notes
Remplacez cette fonction membre pour spécifier une action que l’utilisateur doit effectuer lorsque le bouton Suivant est cliqué.
CSnapInPropertyPageImpl ::QuerySiblings
Appelez cette fonction membre pour transférer un message à chaque page de la feuille de propriétés.
LRESULT QuerySiblings(WPARAM wParam, LPARAM lParam);
Paramètres
wParam
[in] Spécifie des informations supplémentaires dépendantes du message.
lParam
[in] Spécifie des informations supplémentaires dépendantes du message.
Valeur de retour
Différent de zéro si le message ne doit pas être transféré à la page de propriétés suivante ; sinon zéro.
Notes
Si une page retourne une valeur différente de zéro, la feuille de propriétés n’envoie pas le message aux pages suivantes.
CSnapInPropertyPageImpl ::SetModified
Appelez cette fonction membre pour activer ou désactiver le bouton Appliquer maintenant , selon que les paramètres de la page de propriétés doivent être appliqués à l’objet externe approprié.
void SetModified(BOOL bChanged = TRUE);
Paramètres
bChanged
[in] TRUE pour indiquer que les paramètres de la page de propriétés ont été modifiés depuis la dernière fois qu’ils ont été appliqués ; FALSE pour indiquer que les paramètres de la page de propriétés ont été appliqués ou doivent être ignorés.
Notes
La feuille de propriétés suit les pages qui sont « sales », c’est-à-dire les pages de propriétés pour lesquelles vous avez appelé SetModified( TRUE ). Le bouton Appliquer maintenant est toujours activé si vous appelez SetModified( TRUE ) l’une des pages. Le bouton Appliquer maintenant est désactivé lorsque vous appelez SetModified( FALSE ) l’une des pages, mais uniquement si aucune des autres pages n’est « sale ».