PDFKit.GetPDFPageValue
----------------------

Queries a page property.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [PDFKit](component_PDFKit.md) | [5.0](newinversion50.md) | ✅ Yes | ❌ No | ❌ No | ✅ Yes, on macOS | ✅ Yes |

MBS( "PDFKit.GetPDFPageValue"; PDF; Index; Selector; Parameter { ; DontRenderPreview } ) 

**MBS**( **"PDFKit.GetPDFPageValue";** /\* Queries a page property. \*/  
**$PDF**; /\* A PDF reference number from [PDFKit.Open](PDFKitOpen.md).e.g. $ref \*/   
**$Index**; /\* The index of the page. From zero to [PDFKit.GetPDFPageCount](PDFKitGetPDFPageCount.md)-1.e.g. 1 \*/   
**$Selector**; /\* Which value to pick.e.g. "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; Optional for dataRepresentation. Pass 1 to not create a JPEG with preview of first page as part of the container.e.g. 0 \*/ 

### Parameters

| Parameter | Description | Example | Flags |
|---|---|---|---|
| PDF | A PDF reference number from [PDFKit.Open](PDFKitOpen.md). | $ref |  |
| Index | The index of the page. From zero to [PDFKit.GetPDFPageCount](PDFKitGetPDFPageCount.md)-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](PluginSetPreviewSize.md) to control size of preview picture.  
### See also

- [PDFKit.GetPDFPageCount](PDFKitGetPDFPageCount.md)
- [PDFKit.GetPDFPageImage](PDFKitGetPDFPageImage.md)
- [PDFKit.GetPDFPagePDF](PDFKitGetPDFPagePDF.md)
- [PDFKit.GetPDFPagePDFRef](PDFKitGetPDFPagePDFRef.md)
- [PDFKit.GetPDFPagesPDF](PDFKitGetPDFPagesPDF.md)
- [PDFKit.GetPDFPagesPDFRef](PDFKitGetPDFPagesPDFRef.md)
- [PDFKit.GetPDFPageText](PDFKitGetPDFPageText.md)
- [PDFKit.Open](PDFKitOpen.md)
- [Plugin.SetPreviewSize](PluginSetPreviewSize.md)

### Blog Entries

- [MBS FileMaker Plugin, version 5.1pr1](https://www.mbsplugins.de/archive/2015-03-16/MBS_FileMaker_Plugin_version_5/monkeybreadsoftware_blog_filemaker)

### FileMaker Magazin

- [Ausgabe 1/2026, Seite 27 bis 28](https://filemaker-magazin.de/neuigkeit/4312-Die-neue-Ausgabe-FMM_202601-steht-online)

This function checks for a license.

Created 16th February 2015 , last changed 9th November 2021

  
[PDFKit.GetPDFPageText](PDFKitGetPDFPageText.md) - [PDFKit.GetPDFPagesPDF](PDFKitGetPDFPagesPDF.md)

[HTML Version](PDFKitGetPDFPageValue.shtml)