| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
PDFKit.GetPDFPageValue
Queries a page property.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| PDFKit | 5.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes, on macOS | ✅ Yes |
MBS( "PDFKit.GetPDFPageValue"; PDF; index; Selector; Parameter { ; DontRenderPreview } ) More
Parameters
| Parameter | Description | Example | Flags |
|---|---|---|---|
| A PDF reference number from PDFKit.Open. | $ref | ||
| index | The index of the page. From zero to PDFKit.GetPDFPageCount-1. | 1 | |
| Selector | Which value to pick. | "label" | |
| Parameter | For dataRepresentation the filename. For width/height/x/y the index of the box: 0 = media box, 1 = crop box, 2 = bleed box, 3 = trim box, 4 = art box. | ||
| DontRenderPreview | Optional for dataRepresentation. Pass 1 to not create a JPEG with preview of first page as part of the container. | 0 | Optional |
Result
Returns value or error.
Description
Queries a page property.| label | The page label. Usually "1" for the first page, "2" for the second, etc. |
| rotation | Rotation on a page. |
| numberOfCharacters | Number of characters on the page (including linefeeds and spaces inserted). |
| string | String (with linefeeds and in some cases spaces inserted) representing the text on the page. |
| attributedString | Same as string, but with formatting. |
| displaysAnnotations | Whether to display annotations if page is drawn. |
| dataRepresentation | The page as a PDF document. Pass as parameter the file name to use for the container value. |
| width | The width of page. |
| height | The height of page. |
| X | The x offset of page bounds. |
| Y | The y offset of page bounds. |
For X/Y/Width/Height you can specify which box to use in the parameter.
See Plugin.SetPreviewSize to control size of preview picture.
See also
- PDFKit.GetPDFPageCount
- PDFKit.GetPDFPageImage
- PDFKit.GetPDFPagePDF
- PDFKit.GetPDFPagePDFRef
- PDFKit.GetPDFPagesPDF
- PDFKit.GetPDFPagesPDFRef
- PDFKit.GetPDFPageText
- PDFKit.Open
- Plugin.SetPreviewSize
Blog Entries
This function checks for a license.
Created 16th February 2015, last changed 9th November 2021
