IXpsOMTileBrush::SetTileMode method (xpsobjectmodel.h)

Article
02/22/2024

Sets the XPS_TILE_MODE value that describes the tiling mode of the brush.

Syntax

HRESULT SetTileMode(
  [in] XPS_TILE_MODE tileMode
);

Parameters

[in] tileMode

The XPS_TILE_MODE value to be set.

Return value

If the method succeeds, it returns S_OK; otherwise, it returns an HRESULT error code.

Return code	Description
S_OK	The method succeeded.
E_INVALIDARG	tileMode was not a valid XPS_TILE_MODE value.

Remarks

The tile mode determines how the tile image is repeated to fill the output area. If the tile mode value is XPS_TILE_MODE_NONE, the tile image is drawn only once.

An illustration that shows different examples of different tile mode behaviors

Requirements

Requirement	Value
Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	xpsobjectmodel.h