IPreviewHandlerVisuals::SetBackgroundColor method

Sets the background color of the preview handler.

Syntax


HRESULT SetBackgroundColor(
  [in] COLORREF color
);

Parameters

color [in]

Type: COLORREF

A value of type COLORREF to use for the preview handler background.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Note  These are suggestions. It is not compulsory for this method to be called. The preview handlers must be able to make their own decisions.
 

Requirements

Minimum supported client

Windows Vista, Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Redistributable

Windows Search 4 or later

Header

Shobjidl.h

IDL

Shobjidl.idl

 

 

Show: