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

Artigo
08/24/2023

O método IExtendPropertySheet2::GetWatermarks obtém o bitmap de marca d'água e o bitmap de cabeçalho para planilhas de assistente implementadas como assistentes no estilo do Assistente 97.

Sintaxe

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

Parâmetros

[in] lpIDataObject

Um ponteiro para a interface IDataObject no objeto que contém informações de contexto sobre o escopo ou item de resultado.

[out] lphWatermark

Um ponteiro para o identificador para um bitmap que serve como marca d'água para páginas do Assistente 97. Se o identificador para o bitmap for NULL, nenhuma marca d'água será exibida para o assistente. Se esse valor não for NULL, o snap-in, para compatibilidade, deverá gerenciar o tempo de vida do recurso de marca d'água. O snap-in é responsável por liberar o recurso de marca d'água.

[out] lphHeader

Um ponteiro para o identificador para um bitmap que serve como o cabeçalho para páginas do Assistente 97. Se o identificador para o bitmap for NULL, nenhum bitmap será exibido no cabeçalho das páginas do assistente. Se esse valor não for NULL, o snap-in, para compatibilidade, deverá gerenciar o tempo de vida do recurso de cabeçalho. O snap-in é responsável por liberar o recurso de cabeçalho.

[out] lphPalette

Um ponteiro para o identificador para uma paleta que deve ser usada para os bitmaps especificados por lphWatermark e lphHeader. A paleta é NULL por padrão. Se uma paleta não for retornada, a paleta será NULL. Se esse valor não for NULL, o snap-in, para compatibilidade, deverá gerenciar o tempo de vida do recurso de paleta. O snap-in é responsável por liberar o recurso de paleta.

[out] bStretch

Um valor que especifica se a marca d'água e os bitmaps de cabeçalho devem ser estendidos , em vez de em blocos, para caber na área de fundo ou cabeçalho da folha de propriedades. TRUE especifica que a marca d'água e os bitmaps de cabeçalho devem ser estendidos; FALSE especifica que a marca d'água e os bitmaps de cabeçalho devem manter seu tamanho e ser lado a lado. Esse parâmetro é FALSE por padrão. Se um valor bStretch não for retornado, bStretch será FALSE.

Valor retornado

Esse método pode retornar um desses valores.

Comentários

O MMC chama esse método somente quando:

O parâmetro de tipo de IPropertySheetProvider::CreatePropertySheet é definido como FALSE (para a planilha do assistente) e que o parâmetro dwOptions é definido como MMC_PSO_NEWWIZARDTYPE (para o estilo do Assistente 97).
O snap-in passa um ponteiro para sua interface IComponentData ou IComponent como o primeiro parâmetro em chamadas para o método IPropertySheetProvider::AddPrimaryPages .

Se a implementação do snap-in desse método retornar um valor de falha (como E_NOTIMPL), o MMC reverterá a planilha de assistente solicitada pelo snap-in na chamada para IPropertySheetProvider::CreatePropertySheet para o estilo não Assistente 97. Isso é para manter a compatibilidade com o MMC 1.1.

Para evitar distorção da imagem, é recomendável que a marca d'água e os bitmaps de cabeçalho tenham as seguintes dimensões (em pixels) com bStretch definido como FALSE.