Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old


Checks whether a page or the entire document uses transparency.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.GetUsesTransparency"; PDF; PageIndex )   More


Parameter Description Example
PDF The PDF reference returned from DynaPDF.New. $pdf
PageIndex The page index in range from 1 to DynaPDF.GetPageCount. 1


Returns 1, 0 or error.


Checks whether a page or the entire document uses transparency.
This is no quick check as DynaPDF.GetDocUsesTransparency applies. The function parses the page or pages to determine whether transparent objects are really used.
To check whether a specific page uses transparency set the parameter PageNum to the wished page number. The first page is denoted by 1. To check the entire PDF file set PageNum to -1.

The return value is a bit mask on success (a positive integer value), or a error message on failure.
The following flags are defined:
0: The page or document uses no transparency. 
1: The content stream of a page contains transparent objects. 
2: A page defines the blending color space (Group dictionary). 
4: A page contains transparent annotations or form fields. 
The above values can occur in any combination. To check whether a specific flag was set use a binary and operator, e.g. Math.BitwiseAND. e.g. Value 6 means both 2 and 4 flags are set.

See also GetUsesTransparency function in DynaPDF manual.

See also

Release notes

Blog Entries

This function checks for a license.

Created 4th May 2018, last changed 9th November 2021

DynaPDF.GetUserUnit - DynaPDF.GetViewerPreferences