One Logo Pool Ball
X
Github
Discord

System

PDFKit · IOS API REFERENCE

PDFDocument

class · iOS 11.0+ · SDK 27.1

class PDFDocument

Members (50)

method · iOS 11.0+

beginFindString

TypeScript
beginFindString(string: string, options?: _Foundation_NSString_CompareOptions): void
Swift declaration
func beginFindString(_ string: String, withOptions options: NSString.CompareOptions = [])
method · iOS 11.0+

beginFindStrings

TypeScript
beginFindStrings(strings: Array<string>, options?: _Foundation_NSString_CompareOptions): void
Swift declaration
func beginFindStrings(_ strings: [String], withOptions options: NSString.CompareOptions = [])
method · iOS 11.0+

cancelFindString

TypeScript
cancelFindString(): void
Swift declaration
func cancelFindString()
method · iOS 11.0+

dataRepresentation

TypeScript
dataRepresentation(): (ArrayBuffer) | null
Swift declaration
func dataRepresentation() -> Data?
method · iOS 11.0+

dataRepresentation

TypeScript
dataRepresentationOptions(options?: NativeMap<unknown, unknown>): (ArrayBuffer) | null
Swift declaration
func dataRepresentation(options: [AnyHashable : Any] = [:]) -> Data?
method · iOS 11.0+

exchangePage

TypeScript
exchangePage(indexA: number, indexB: number): void
Swift declaration
func exchangePage(at indexA: Int, withPageAt indexB: Int)
method · iOS 11.0+

findString

TypeScript
findStringFromSelectionWithOptions(string: string, selection?: (PDFSelection) | null, options?: _Foundation_NSString_CompareOptions): (PDFSelection) | null
Swift declaration
func findString(_ string: String, fromSelection selection: PDFSelection?, withOptions options: NSString.CompareOptions = []) -> PDFSelection?
method · iOS 11.0+

findString

TypeScript
findStringWithOptions(string: string, options?: _Foundation_NSString_CompareOptions): Array<PDFSelection>
Swift declaration
func findString(_ string: String, withOptions options: NSString.CompareOptions = []) -> [PDFSelection]
method · iOS 11.0+

index

TypeScript
index(page: PDFPage): number
Swift declaration
func index(for page: PDFPage) -> Int
init · iOS 11.0+

init

TypeScript
static init(): PDFDocument
Swift declaration
init()
init · iOS 11.0+

init

TypeScript
static initData(data: ArrayBuffer): (PDFDocument) | null
Swift declaration
init?(data: Data)
init · iOS 11.0+

init

TypeScript
static initUrl(url: string): (PDFDocument) | null
Swift declaration
init?(url: URL)
method · iOS 11.0+

insert

TypeScript
insert(page: PDFPage, index: number): void
Swift declaration
func insert(_ page: PDFPage, at index: Int)
method · iOS 11.0+

outlineItem

TypeScript
outlineItem(selection: PDFSelection): (PDFOutline) | null
Swift declaration
func outlineItem(for selection: PDFSelection) -> PDFOutline?
method · iOS 11.0+

page

TypeScript
page(index: number): (PDFPage) | null
Swift declaration
func page(at index: Int) -> PDFPage?
method · iOS 11.0+

removePage

TypeScript
removePage(index: number): void
Swift declaration
func removePage(at index: Int)
method · iOS 11.0+

selection

TypeScript
selectionFromAtCharacterIndexToAtCharacterIndex(startPage: PDFPage, startCharacter: number, endPage: PDFPage, endCharacter: number): (PDFSelection) | null
Swift declaration
func selection(from startPage: PDFPage, atCharacterIndex startCharacter: Int, to endPage: PDFPage, atCharacterIndex endCharacter: Int) -> PDFSelection?
method · iOS 11.0+

selection

TypeScript
selectionFromAtToAt(startPage: PDFPage, startPoint: { x: number; y: number }, endPage: PDFPage, endPoint: { x: number; y: number }): (PDFSelection) | null
Swift declaration
func selection(from startPage: PDFPage, at startPoint: CGPoint, to endPage: PDFPage, at endPoint: CGPoint) -> PDFSelection?
method · iOS 18.0+

selection

TypeScript
selectionFromAtToAtWith(startPage: PDFPage, startPoint: { x: number; y: number }, endPage: PDFPage, endPoint: { x: number; y: number }, granularity: PDFSelectionGranularity): (PDFSelection) | null
Swift declaration
func selection(from startPage: PDFPage, at startPoint: CGPoint, to endPage: PDFPage, at endPoint: CGPoint, with granularity: PDFSelectionGranularity) -> PDFSelection?
method · iOS 11.0+

unlock

TypeScript
unlock(password: string): boolean
Swift declaration
func unlock(withPassword password: String) -> Bool
method · iOS 11.0+

write

TypeScript
writeToFile(path: string): boolean
Swift declaration
func write(toFile path: String) -> Bool
method · iOS 11.0+

write

TypeScript
writeToFileWithOptions(path: string, options?: (NativeMap<PDFDocumentWriteOption, unknown>) | null): boolean
Swift declaration
func write(toFile path: String, withOptions options: [PDFDocumentWriteOption : Any]? = nil) -> Bool
method · iOS 11.0+

write

TypeScript
writeTo(url: string): boolean
Swift declaration
func write(to url: URL) -> Bool
method · iOS 11.0+

write

TypeScript
writeToWithOptions(url: string, options?: (NativeMap<PDFDocumentWriteOption, unknown>) | null): boolean
Swift declaration
func write(to url: URL, withOptions options: [PDFDocumentWriteOption : Any]? = nil) -> Bool
get · iOS 11.0+

accessPermissions

TypeScript
get accessPermissions(): PDFAccessPermissions
Swift declaration
var accessPermissions: PDFAccessPermissions { get }
get · iOS 11.0+

allowsCommenting

TypeScript
get allowsCommenting(): boolean
Swift declaration
var allowsCommenting: Bool { get }
get · iOS 11.0+

allowsContentAccessibility

TypeScript
get allowsContentAccessibility(): boolean
Swift declaration
var allowsContentAccessibility: Bool { get }
get · iOS 11.0+

allowsCopying

TypeScript
get allowsCopying(): boolean
Swift declaration
var allowsCopying: Bool { get }
get · iOS 11.0+

allowsDocumentAssembly

TypeScript
get allowsDocumentAssembly(): boolean
Swift declaration
var allowsDocumentAssembly: Bool { get }
get · iOS 11.0+

allowsDocumentChanges

TypeScript
get allowsDocumentChanges(): boolean
Swift declaration
var allowsDocumentChanges: Bool { get }
get · iOS 11.0+

allowsFormFieldEntry

TypeScript
get allowsFormFieldEntry(): boolean
Swift declaration
var allowsFormFieldEntry: Bool { get }
get · iOS 11.0+

allowsPrinting

TypeScript
get allowsPrinting(): boolean
Swift declaration
var allowsPrinting: Bool { get }
get · iOS 11.0+

delegate

TypeScript
get delegate(): (SDKHandle) | null
Swift declaration
weak var delegate: (any PDFDocumentDelegate)? { get set }
set · iOS 11.0+

delegate

TypeScript
set delegate(value: (Implements<PDFDocumentDelegate> | SDKHandle) | null)
Swift declaration
weak var delegate: (any PDFDocumentDelegate)? { get set }
get · iOS 11.0+

documentAttributes

TypeScript
get documentAttributes(): (NativeMap<unknown, unknown>) | null
Swift declaration
var documentAttributes: [AnyHashable : Any]? { get set }
set · iOS 11.0+

documentAttributes

TypeScript
set documentAttributes(value: (NativeMap<unknown, unknown>) | null)
Swift declaration
var documentAttributes: [AnyHashable : Any]? { get set }
get · iOS 11.0+

documentRef

TypeScript
get documentRef(): (_CoreGraphics_CGPDFDocument) | null
Swift declaration
var documentRef: CGPDFDocument? { get }
get · iOS 11.0+

documentURL

TypeScript
get documentURL(): (string) | null
Swift declaration
var documentURL: URL? { get }
get · iOS 11.0+

isEncrypted

TypeScript
get isEncrypted(): boolean
Swift declaration
var isEncrypted: Bool { get }
get · iOS 11.0+

isFinding

TypeScript
get isFinding(): boolean
Swift declaration
var isFinding: Bool { get }
get · iOS 11.0+

isLocked

TypeScript
get isLocked(): boolean
Swift declaration
var isLocked: Bool { get }
get · iOS 11.0+

majorVersion

TypeScript
get majorVersion(): number
Swift declaration
var majorVersion: Int { get }
get · iOS 11.0+

minorVersion

TypeScript
get minorVersion(): number
Swift declaration
var minorVersion: Int { get }
get · iOS 11.0+

outlineRoot

TypeScript
get outlineRoot(): (PDFOutline) | null
Swift declaration
var outlineRoot: PDFOutline? { get set }
set · iOS 11.0+

outlineRoot

TypeScript
set outlineRoot(value: (PDFOutline) | null)
Swift declaration
var outlineRoot: PDFOutline? { get set }
get · iOS 11.0+

pageClass

TypeScript
get pageClass(): string
Swift declaration
var pageClass: AnyClass { get }
get · iOS 11.0+

pageCount

TypeScript
get pageCount(): number
Swift declaration
var pageCount: Int { get }
get · iOS 11.0+

permissionsStatus

TypeScript
get permissionsStatus(): PDFDocumentPermissions
Swift declaration
var permissionsStatus: PDFDocumentPermissions { get }
get · iOS 11.0+

selectionForEntireDocument

TypeScript
get selectionForEntireDocument(): (PDFSelection) | null
Swift declaration
var selectionForEntireDocument: PDFSelection? { get }
get · iOS 11.0+

string

TypeScript
get string(): (string) | null
Swift declaration
var string: String? { get }

Skipped declarations

No declarations were skipped in this snapshot.

All PDFKit types →