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


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


Parameter Description Example Flags
PDF 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


Returns value or error.


Queries a page property.

labelThe page label. Usually "1" for the first page, "2" for the second, etc.
rotationRotation on a page.
numberOfCharactersNumber of characters on the page (including linefeeds and spaces inserted).
stringString (with linefeeds and in some cases spaces inserted) representing the text on the page.
attributedStringSame as string, but with formatting.
displaysAnnotationsWhether to display annotations if page is drawn.
dataRepresentationThe page as a PDF document. Pass as parameter the file name to use for the container value.
widthThe width of page.
heightThe height of page.
XThe x offset of page bounds.
YThe 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

Blog Entries

This function checks for a license.

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

PDFKit.GetPDFPageText - PDFKit.GetPDFPagesPDF