IXpsOMTileBrush::SetViewport method
Sets the portion of the destination geometry that is covered by a single tile.
Syntax
HRESULT SetViewport(
[in] const XPS_RECT *viewport
);
Parameters
- viewport [in]
An XPS_RECT structure that describes the portion of the destination geometry that is covered by a single tile.
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 | viewport is NULL. |
| E_INVALIDARG | The rectangle described in viewport is not valid. |
Remarks
The viewport is the portion of the output area where the tile is drawn. In the following illustration, the viewport is outlined by the blue rectangle inside the red, dotted rectangle. The tile mode of the brush determines how other tiles are drawn in the output area.
.png "An image that shows how a viewport is mapped to the output area")
Requirements
Minimum supported client |
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps] |
Minimum supported server |
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps] |
Header |
Xpsobjectmodel.h |
IDL |
XpsObjectModel.idl |