Topics
All
MacOS
(Only)
Windows
(Only)
Linux
(Only, Not)
iOS
(Only, Not)
Components
Crossplatform Mac & Win
Server
Client
Old
Deprecated
Guides
Examples
Videos
New in version:
10.1
10.2
10.3
10.4
10.5
11.0
11.1
11.2
11.3
11.4
Statistic
FMM
Blog
Queries a page property.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
PDFKit | 5.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes, on macOS | ✅ Yes |
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 |
Returns OK or error.
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. |
Created 16th February 2015, last changed 9th March 2015
PDFKit.GetPDFPageText - PDFKit.GetPDFPagesPDF
Feedback: Report problem or ask question.