Edit

IXpsOMVisual::SetOpacity method (xpsobjectmodel.h)

  • Article

Sets the opacity value of the visual.

Syntax

HRESULT SetOpacity(
  [in] FLOAT opacity
);

Parameters

[in] opacity

The opacity value to be set for the visual.

The range of allowed values for this parameter is 0.0 to 1.0; with 0.0 the visual is completely transparent, and with 1.0 it is completely opaque.

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
 opacity contains a value that is not allowed.

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

IXpsOMVisual

XML Paper Specification

XPS Document Errors