Partager via

IOleWindow ::ContextSensitiveHelp, méthode (oleidl.h)

  • Article

Détermine si le mode d’aide respectant le contexte doit être entré pendant une session d’activation sur place.

Syntaxe

HRESULT ContextSensitiveHelp(
  [in] BOOL fEnterMode
);

Paramètres

[in] fEnterMode

TRUE si le mode d’aide doit être entré ; FALSE si elle doit être supprimée.

Valeur retournée

Cette méthode retourne S_OK si le mode d’aide a été entré ou quitté correctement, en fonction de la valeur passée dans fEnterMode. Les autres valeurs de retour possibles sont les suivantes.

Code de retour Description
E_INVALIDARG
 La valeur fEnterMode spécifiée n’est pas valide.
E_OUTOFMEMORY
 La mémoire disponible pour cette opération est insuffisante.
E_UNEXPECTED
 Une erreur inattendue s’est produite.

Remarques

Les applications peuvent appeler de l’aide contextuelle lorsque l’utilisateur :

  • appuie sur MAJ+F1, puis clique sur une rubrique
  • appuie sur F1 lorsqu’un élément de menu est sélectionné
Lorsque la touche Maj+F1 est enfoncée, le cadre ou l’objet actif peut recevoir les frappes. Si l’image du conteneur reçoit les frappes, elle appelle la méthode IOleWindow ::ContextSensitiveHelp du document contenant avec fEnterMode définie sur TRUE. Cela propage l’état d’aide à tous ses objets sur place afin qu’ils puissent gérer correctement le clic de la souris ou WM_COMMAND.

Si un objet actif reçoit les frappes MAJ+F1, il appelle la méthode IOleWindow ::ContextSensitiveHelp du conteneur avec fEnterModeTRUE, qui appelle ensuite de manière récursive chacun de ses sites sur place jusqu’à ce qu’il n’y ait plus de notification. Le conteneur appelle ensuite la méthode IOleWindow ::ContextSensitiveHelp de son document ou de son cadre avec fEnterModeTRUE.

En mode d’aide respectant le contexte, un objet qui reçoit le clic de souris peut :

  • Ignorez le clic s’il ne prend pas en charge l’aide contextuelle.
  • Indiquez à tous les autres objets de quitter le mode d’aide contextuel avec ContextSensitiveHelp défini sur FALSE , puis fournissez de l’aide pour ce contexte.
Un objet en mode d’aide contextuel qui reçoit une WM_COMMAND doit indiquer à tous les autres objets sur place de quitter le mode d’aide contextuel, puis fournir de l’aide pour la commande.

Si une application conteneur doit prendre en charge l’aide contextuelle sur les éléments de menu, elle doit fournir son propre filtre de message afin qu’elle puisse intercepter la clé F1 ou demander à la bibliothèque OLE d’ajouter un filtre de message en appelant OleSetMenuDescriptor, en transmettant des valeurs valides et non NULL pour les paramètres lpFrame et lpActiveObj .

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête oleidl.h

Voir aussi

IOleWindow

OleSetMenuDescriptor