Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IXpsOMTileBrush::SetTransformLookup method

Sets the lookup key name of a shared matrix transform that will be used as the transform for this brush. The shared matrix transform that is referenced by the lookup key is stored in the resource dictionary.

Syntax


HRESULT SetTransformLookup(
  [in] LPCWSTR key
);

Parameters

key [in]

A string variable that contains the lookup key name of a shared matrix transform in the resource dictionary. If a lookup key has already been set, a NULL pointer will clear it.

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 codeDescription
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

The transform is applied before the brush image is rendered in the path, stroke, or glyph that is using the tile brush. The tile brush has only one transform, which can be local or remote.

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 calledObject that is returned in transform by GetTransform Object that is returned in transform by GetTransformLocal String that is returned in key by GetTransformLookup

SetTransformLocal

The transform that is set by SetTransformLocal.

The transform that is set by SetTransformLocal.

NULL pointer.

SetTransformLookup (this method)

The transform which is retrieved—using 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.

 

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

See also

IXpsOMTileBrush
XPS Document Errors
XML Paper Specification

 

 

Show:
© 2016 Microsoft