IXpsOMGradientBrush::SetTransformLocal method (xpsobjectmodel.h)

Article
10/13/2021

Sets the IXpsOMMatrixTransform interface pointer to a local, unshared matrix transform that is to be used for the brush.

Syntax

HRESULT SetTransformLocal(
  [in] IXpsOMMatrixTransform *transform
);

Parameters

[in] transform

A pointer to the IXpsOMMatrixTransform interface of the local, unshared matrix transform that is to be used for the brush. A NULL pointer releases any previously set interface.

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.
XPS_E_NO_CUSTOM_OBJECTS	transform does not point to a recognized interface implementation. Custom implementation of XPS Document API interfaces is not supported.

Remarks

After you call SetTransformLocal, the transform lookup key is released and GetTransformLocal returns a NULL pointer in the transform parameter. The table that follows explains the relationship between the local and lookup values of this property.

Most recent method called	Object that is returned in transform by GetTransform	Object that is returned in transform by GetTransformLocal	Object that is returned in key by GetTransformLookup
SetTransformLocal (this method)	The local transform that is set by SetTransformLocal.	The local transform that is set by SetTransformLocal.	NULL pointer.
SetTransformLookup	The shared transform retrieved, with a lookup key that matches the key that is set by SetTransformLookup, from the resource directory.	NULL pointer.	The lookup key that is set by SetTransformLookup.
Neither SetTransformLocal nor SetTransformLookup has been called yet.	NULL pointer.	NULL pointer.	NULL pointer.

The transform passed in transform determines how the gradient is transformed. The visible part of the gradient that is ultimately rendered in the image is determined by the path, stroke, or glyph that is using the gradient brush.

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