IXpsOMGlyphs::SetOrigin method (xpsobjectmodel.h)

Article
02/22/2024

Sets the starting position of the text.

Syntax

HRESULT SetOrigin(
  [in] const XPS_POINT *origin
);

Parameters

[in] origin

The XPS_POINT structure that contains the coordinates to be set as the text's starting position.

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	origin is NULL.
E_INVALIDARG	origin.x or origin.y refers to a floating-point value that is not valid.

Remarks

In the units of the effective coordinate space, the origin specifies the x and y coordinates of the first glyph in the run. The glyph is placed such that its baseline and the leading edge of its advance vector intersect with the point defined by origin.x and origin.y.

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