IXpsOMRadialGradientBrush::SetGradientOrigin method (xpsobjectmodel.h)

Article
02/22/2024

Sets the origin point of the radial gradient.

Syntax

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

Parameters

[in] origin

The x and y coordinates to be set for the origin point of the radial gradient.

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_INVALIDARG	The point described by origin was not valid. The XPS_POINT structure must contain valid and finite floating-point values.
E_POINTER	origin is NULL.

Remarks

The x and y coordinates that are specified in origin are relative to the page and are expressed in units of the transform that is in effect.

The following illustration shows the parts of a radial gradient. origin sets the location of the radial gradient's origin. For a more detailed description of this diagram, see IXpsOMRadialGradientBrush.

A figure that shows the terms used in a radial gradient

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