IXpsOMPath::SetStrokeDashOffset method (xpsobjectmodel.h)

Sets the offset from the origin of the stroke to the starting point of the dash array pattern.

Syntax

HRESULT SetStrokeDashOffset(
  [in] FLOAT strokeDashOffset
);

Parameters

[in] strokeDashOffset

The offset value to be set.

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
strokeDashOffset is not a valid offset value.

Remarks

The offset describes the distance from the origin of the stroke where the dash starts, and is specified in multiples of the stroke thickness.

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

See also

IXpsOMPath

XML Paper Specification

XPS Document Errors