IXpsOMGradientStop::SetOffset method

Sets the offset location of the gradient stop.

Syntax

HRESULT SetOffset(
  FLOAT offset
);

Parameters

offset

The offset value that describes the location of the gradient stop as a fraction of the gradient path.

The valid range of this parameter is 0.0 <= offset <= 1.0.

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
offset did not contain a valid offset value.

Requirements

   
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

See also

IXpsOMGradientStop

XML Paper Specification

XPS Document Errors