Freigeben über


IXpsOMRadialGradientBrush::SetRadiiSizes method

Sets the sizes of the radii that define ellipse of the radial gradient region.

Syntax

HRESULT SetRadiiSizes(
  [in] const XPS_SIZE *radiiSizes
);

Parameters

  • radiiSizes [in]
    The XPS_SIZE structure that receives the sizes of the radii.

    Field Meaning

    width

    Size of the radius along the x-axis.

    height

    Size of the radius along the y-axis.

     

    Size is described in XPS units. There are 96 XPS units per inch. For example, a 1" radius is 96 XPS units.

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

One of the sizes described by radiiSizes is not valid. The XPS_SIZE structure must contain valid, finite, and non-negative floating-point values.

E_POINTER

radiiSizes is NULL.

 

Remarks

The following illustration identifies the parts of a radial gradient. radiiSizes.width sets the x-radius, and radiiSizes.height the y-radius. For a more detailed description of this diagram, see IXpsOMRadialGradientBrush.

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

See also

IXpsOMRadialGradientBrush

XPS_SIZE

XPS Document Errors

XML Paper Specification