IXpsOMGradientBrush::SetTransformLookup method

Article
06/01/2017

Sets the name of the lookup key of a shared matrix transform that is to be used for the brush.

The key name identifies a shared resource in a resource dictionary.

Syntax

HRESULT SetTransformLookup(
  [in] LPCWSTR key
);

Parameters

key [in]
The name of the lookup key of the matrix transform that is to be used for the brush.

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_INVALID_RESOURCE_KEY	According to the XML Paper Specification, the value of lookup is not a valid lookup key string.
XPS_E_INVALID_LOOKUP_TYPE	The lookup key name in key references an object that is not a geometry.
XPS_E_LOOKUP_NOT_FOUND	No object could be found with a key name that matched the value passed in key.

Remarks

After you call SetTransformLookup, the local transform 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	The local transform that is set by SetTransformLocal.	The local transform that is set by SetTransformLocal.	NULL pointer.
SetTransformLookup (this method)	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 referenced by key 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 brush.

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

Share via