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

DynaPDF.ListImages

Lists images in a PDF.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 6.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes

Deprecated

This function was deprecated. Use DynaPDF.GetImage instead.

MBS( "DynaPDF.ListImages"; PDF { ; Flags; Page } )   More

Parameters

Parameter Description Example Flags
PDF The PDF reference returned from DynaPDF.New. $pdf
Flags Optional, various flags for PDF parsing. 0 Optional
Page The page number to look at.
If missing or empty, we process all pages.		 123 Optional

Result

Returns list or error.

Description

Lists images in a PDF.
This is similar to DynaPDF.ExtractImages, but does not write to disk, but returns information.
For the flags, please check the pf flags in dynapdf manual.

The result is a list of values.
First value is the number of images.
Than for each image you get
  • Index of image.
  • Page Numbers this image is on separated by space.
  • Type of image file we would write when extracting: TIFF, JPEG or JPEG2000.
  • Size of image in bytes
  • Bits per Pixel, e.g. 8
  • Number of Components, e.g. 3 for RGB, 4 for CMYK
  • Width in Pixel
  • Height in Pixel
  • 1 for inline graphic, else 0.
  • 1 for interpolation enabled, else 0.
  • 1 for transparency enabled, else 0.
  • Rendering Intent, e.g. AbsoluteColorimetric, Perceptual, RelativeColorimetric, Saturation or None.
  • Size of metadata stream (XMP)
  • Color Space Type, e.g. DeviceRGB
  • ICC Color Profile Type if one exists, else none.
  • ICC Color Profile alternate color space.
  • Size of ICC Profile data
  • Number of input components
  • Number of output components
  • Number of colors (for palettes)
  • Colorants Count
  • Colorants names separated by tab.
  • Horizontal resolution of JPEG if available.
  • Vertical resolution of JPEG if available.
  • Display Width
  • Display Height

The ICC Profile is often not part of the PDF as most software converts to DeviceCMYK or uses current profile set in PDF. Display width and height is calculated by the plugin. That is the size of points on the page the PDF is drawn. If Display width and pixel width are the same, the image is displayed with 72 dpi.

This function uses the parser interface in DynaPDF and needs a Pro license.

Deprecated in favor of DynaPDF.GetImage and DynaPDF.GetImageCount.

See also

Release notes

Example Databases

Blog Entries

This function checks for a license.

Created 19th July 2016, last changed 25th July 2021


DynaPDF.List - DynaPDF.LockLayer