IXpsOMTileBrush::GetTileMode method (xpsobjectmodel.h)

Article
02/22/2024

Gets the XPS_TILE_MODE value that describes the tile mode of the brush.

Syntax

HRESULT GetTileMode(
  [out, retval] XPS_TILE_MODE *tileMode
);

Parameters

[out, retval] tileMode

The XPS_TILE_MODE value that describes the tile mode of the brush.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code	Description
S_OK	The method succeeded.
E_POINTER	tileMode is NULL.

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. The following illustration shows examples of how the tile image appears in several tile modes.

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

Share via