Méthode IExtendPropertySheet2::GetWatermarks (mmc.h)

Article
08/24/2023

La méthode IExtendPropertySheet2::GetWatermarks obtient l’image bitmap et l’en-tête de filigrane pour les feuilles de l’Assistant implémentées en tant qu’Assistants de style 97.

Syntaxe

HRESULT GetWatermarks(
  [in]  LPDATAOBJECT lpIDataObject,
  [out] HBITMAP      *lphWatermark,
  [out] HBITMAP      *lphHeader,
  [out] HPALETTE     *lphPalette,
  [out] BOOL         *bStretch
);

Paramètres

[in] lpIDataObject

Pointeur vers l’interface IDataObject sur l’objet qui contient des informations de contexte sur l’étendue ou l’élément de résultat.

[out] lphWatermark

Pointeur vers le handle vers une bitmap qui sert de filigrane pour les pages de l’Assistant 97. Si le handle de la bitmap est NULL, aucun filigrane n’est affiché pour l’Assistant. Si cette valeur n’est pas NULL, le composant logiciel enfichable, à des fins de compatibilité, doit gérer la durée de vie de la ressource de filigrane. Le composant logiciel enfichable est chargé de libérer la ressource de filigrane.

[out] lphHeader

Pointeur vers le handle vers une bitmap qui sert d’en-tête pour les pages de l’Assistant 97. Si le handle de la bitmap est NULL, aucune bitmap n’est affichée dans l’en-tête des pages de l’Assistant. Si cette valeur n’est pas NULL, le composant logiciel enfichable, pour la compatibilité, doit gérer la durée de vie de la ressource d’en-tête. Le composant logiciel enfichable est chargé de libérer la ressource d’en-tête.

[out] lphPalette

Pointeur vers le handle vers une palette qui doit être utilisée pour les bitmaps spécifiées par lphWatermark et lphHeader. La palette a la valeur NULL par défaut. Si aucune palette n’est retournée, la palette a la valeur NULL. Si cette valeur n’est pas NULL, le composant logiciel enfichable, à des fins de compatibilité, doit gérer la durée de vie de la ressource de palette. Le composant logiciel enfichable est chargé de libérer la ressource de palette.

[out] bStretch

Valeur qui spécifie si les bitmaps de filigrane et d’en-tête doivent être étirées (au lieu de mosaïques) pour s’adapter à l’arrière-plan ou à la zone d’en-tête de la feuille de propriétés. TRUE spécifie que les bitmaps de filigrane et d’en-tête doivent être étirées ; FALSE spécifie que les bitmaps de filigrane et d’en-tête doivent conserver leur taille et être en mosaïque. Ce paramètre est FALSE par défaut. Si une valeur bStretch n’est pas retournée, bStretch a la valeur FALSE.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Notes

MMC appelle cette méthode uniquement dans les cas suivants :

Le paramètre de type de IPropertySheetProvider::CreatePropertySheet a la valeur FALSE (pour la feuille de l’Assistant) et le paramètre dwOptions est défini sur MMC_PSO_NEWWIZARDTYPE (pour le style Assistant 97).
Le composant logiciel enfichable transmet un pointeur vers son interface IComponentData ou IComponent comme premier paramètre dans les appels à la méthode IPropertySheetProvider::AddPrimaryPages .

Si l’implémentation du composant logiciel enfichable de cette méthode retourne une valeur d’échec (telle que E_NOTIMPL), MMC rétablit la feuille d’Assistant demandée par le composant logiciel enfichable dans l’appel à IPropertySheetProvider::CreatePropertySheet au style 97 autre que l’Assistant. Il s’agit de maintenir la compatibilité avec MMC 1.1.

Pour empêcher la distorsion de l’image, il est recommandé que les bitmaps de filigrane et d’en-tête aient les dimensions suivantes (en pixels) avec bStretch défini sur FALSE.