IXpsOMBrush::SetOpacity method
Sets the opacity of the brush.
Syntax
HRESULT SetOpacity(
[in] FLOAT opacity
);
Parameters
- opacity [in]
The opacity value of the brush.
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 is not a valid value. See the Remarks section. |
Remarks
opacity is expressed as a value between 0.0 and 1.0; 0.0 indicates that the brush is completely transparent, 0.5 that it is 50 percent opaque, and 1.0 that it is completely opaque.
If opacity is less than 0.0 or greater than 1.0, the method returns an error.
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 |