Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
DynaPDF.Parser.DeleteImage
Deletes one image from the page.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
DynaPDF | 14.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "DynaPDF.Parser.DeleteImage"; PDF; ImageHandle { ; Nth } ) More
Parameters
Parameter | Description | Example | Flags |
---|---|---|---|
The PDF reference returned from DynaPDF.New. | |||
ImageHandle | The image handle for the image to remove. From 0 to DynaPDF.GetImageCount-1. |
0 | |
Nth | The offset of the image in the list. If the same picture is shown multiple times on the page, you can put a number here to address is. Default is 0. |
0 | Optional |
Result
Returns OK or error.
Description
Deletes one image from the page.We look for the first image on the page matching the given handle number and remove it.
If the same image is shown multiple times on the page, it appears multiple time in the array returned by ListImages and you need to call DeleteImage multiple times.
You need to call DynaPDF.Parser.WriteToPage later to save changes back to page.
See also
- DynaPDF.GetImage
- DynaPDF.GetImageCount
- DynaPDF.New
- DynaPDF.Parser.DeleteAllImages
- DynaPDF.Parser.DeleteText
- DynaPDF.Parser.ListImages
- DynaPDF.Parser.ParsePage
- DynaPDF.Parser.WriteToPage
Release notes
- Version 14.5
- Added DynaPDF.Parser.DeleteAllImages, DynaPDF.Parser.DeleteImage and DynaPDF.Parser.ListImages functions.
Blog Entries
This function checks for a license.
Created 28th October 2024, last changed 9th November 2024