IXpsOMRadialGradientBrush::GetGradientOrigin method
Gets the origin point of the radial gradient.
Syntax
HRESULT GetGradientOrigin(
[out, retval] XPS_POINT *origin
);
Parameters
- origin [out, retval]
The x and y coordinates of the radial gradient's origin point.
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. |
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 gets the location of the gradient origin. For a more detailed description of this diagram, see IXpsOMRadialGradientBrush.
.png "A figure that shows the terms used in a radial gradient")
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 |