The document SDKs you’re looking for

1
import PSPDFKit from "pspdfkit";
2

3
// Obtain a PSPDFKit document instance.
4
const instance = await PSPDFKit.load({
5
  container: "#pspdfkit",
6
  document: "<document-file-path>",
7
  licenseKey: "<license-key>"
8
});
9

10
console.log("PSPDFKit for Web is ready!");
11
console.log(instance);

1
import DocAuth from '@pspdfkit/document-authoring';
2

3
const docAuthSystem = await DocAuth.createDocAuthSystem({
4
  licenseKey: '<license-key>',
5
});
6

7
const editor = await docAuthSystem.createEditor(
8
  document.getElementById('editor'),
9
  {
10
    document: await docAuthSystem.createDocumentFromPlaintext('Hi there!'),
11
  }
12
);

1
import PSPDFKit
2
import PSPDFKitUI
3
import SwiftUI
4

5
// A `Document` is the container for your PDF file.
6
let document = Document(url: documentURL)
7

8
var body: some View {
9
  // A `PDFView` will present and manage the PSPDFKit UI.
10
  PDFView(document: document)
11
    .scrollDirection(.vertical)
12
    .pageTransition(.scrollContinuous)
13
    .pageMode(.single)
14
}

1
- (instancetype)initWithFrame:(CGRect)frame {
2
  if ((self = [super initWithFrame:frame])) {
3
    // Set configuration to use the custom annotation toolbar when initializing the `PSPDFViewController`.
4
    // For more details, see `PSCCustomizeAnnotationToolbarExample.m` from PSPDFCatalog and our documentation here: https://pspdfkit.com/guides/ios/customizing-the-interface/customize-the-annotation-toolbar/
5
    _pdfController = [[PSPDFViewController alloc] initWithDocument:nil configuration:[PSPDFConfiguration configurationWithBuilder:^(PSPDFConfigurationBuilder *builder) {
6
      [builder overrideClass:PSPDFAnnotationToolbar.class withClass:CustomButtonAnnotationToolbar.class];
7
    }]];
8

9
    _pdfController.delegate = self;
10
    _pdfController.annotationToolbarController.delegate = self;
11
    _closeButton = [[UIBarButtonItem alloc] initWithImage:[PSPDFKitGlobal imageNamed:@"x"] style:UIBarButtonItemStylePlain target:self action:@selector(closeButtonPressed:)];
12

13
    [NSNotificationCenter.defaultCenter addObserver:self selector:@selector(annotationChangedNotification:) name:PSPDFAnnotationChangedNotification object:nil];
14
    [NSNotificationCenter.defaultCenter addObserver:self selector:@selector(annotationChangedNotification:) name:PSPDFAnnotationsAddedNotification object:nil];
15
    [NSNotificationCenter.defaultCenter addObserver:self selector:@selector(annotationChangedNotification:) name:PSPDFAnnotationsRemovedNotification object:nil];
16
  }
17

18
  return self;
19
}

1
package com.your.package
2

3
import android.net.Uri
4
import android.os.Bundle
5
import androidx.appcompat.app.AppCompatActivity
6
import com.pspdfkit.ui.PdfActivityIntentBuilder
7

8
// We need to use a Compat activity for the PdfFragment.
9
class MainActivity : AppCompatActivity() {
10
  override fun onCreate(savedInstanceState: Bundle?) {
11
    super.onCreate(savedInstanceState)
12

13
    // Get the document path from the application assets.
14
    val documentUri = Uri.parse("file:///android_asset/document.pdf")
15

16
    // Build the `Intent` for launching the `PdfActivity`.
17
    val intent = PdfActivityIntentBuilder.fromUri(this, documentUri)
18
      .build()
19
    startActivity(intent)
20
  }
21
}

1
package com.your.package;
2

3
import android.net.Uri;
4
import android.os.Bundle;
5
import androidx.appcompat.app.AppCompatActivity;
6
import com.pspdfkit.ui.PdfActivityIntentBuilder;
7

8
// We need to use a Compat activity for the PdfFragment.
9
public class MainActivity extends AppCompatActivity {
10
  @Override
11
  protected void onCreate(Bundle savedInstanceState) {
12
    super.onCreate(savedInstanceState);
13

14
    // Get the document path from the application assets.
15
    Uri documentUri = Uri.parse("file:///android_asset/document.pdf");
16

17
    // Build the Intent for launching the PdfActivity.
18
    Intent intent = PdfActivityIntentBuilder.fromUri(this, documentUri)
19
      .build();
20
    startActivity(intent);
21
  }
22
}

1
import 'dart:io';
2

3
import 'package:flutter/material.dart';
4
import 'package:path_provider/path_provider.dart';
5
import 'package:pspdfkit_flutter/pspdfkit.dart';
6

7
const String DOCUMENT_PATH = 'PDFs/Document.pdf';
8

9
void main() => runApp(MyApp());
10

11
class MyApp extends StatefulWidget {
12
@override
13
_MyAppState createState() => _MyAppState();
14
}
15

16
class _MyAppState extends State<MyApp> {
17
void showDocument(BuildContext context) async {
18
  final bytes = await DefaultAssetBundle.of(context).load(DOCUMENT_PATH);
19
  final list = bytes.buffer.asUint8List();
20

21
  final tempDir = await getTemporaryDirectory();
22
  final tempDocumentPath = '${tempDir.path}/$DOCUMENT_PATH';
23

24
  final file = await File(tempDocumentPath).create(recursive: true);
25
  file.writeAsBytesSync(list);
26

27
  await Pspdfkit.present(tempDocumentPath);
28
}
29

30
@override
31
Widget build(BuildContext context) {
32
  final theme = Theme.of(context);
33
  return MaterialApp(
34
    home: Scaffold(body:
35
      Center(
36
        child: ElevatedButton(
37
          onPressed: () => showDocument(context),
38
          child: Text('Show Document'),
39
        )
40
      )
41
    )
42
  );
43
}
44
}

1
import React, {Component} from 'react';
2
import {Platform} from 'react-native';
3
import PSPDFKitView from 'react-native-pspdfkit';
4

5
const DOCUMENT =
6
  Platform.OS === 'ios' ? 'Document.pdf' : 'file:///android_asset/Document.pdf';
7
export default class PSPDFKitDemo extends Component<{}> {
8
  render() {
9
  return (
10
    <PSPDFKitView
11
    document={DOCUMENT}
12
    configuration={{
13
      showThumbnailBar: 'scrollable',
14
      pageTransition: 'scrollContinuous',
15
      scrollDirection: 'vertical',
16
    }}
17
    ref={this.pdfRef}
18
    fragmentTag="PDF1"
19
    style={{flex: 1}}
20
    />
21
  );
22
  }
23
}

1
// Install the plugin first:
2
// cordova plugin add pspdfkit-cordova
3

4
document.addEventListener('deviceready', function() {
5
  // Open a PDF document
6
  PSPDFKit.present('document.pdf', {
7
    pageTransition: 'scrollContinuous',
8
    scrollDirection: 'vertical',
9
    backgroundColor: '#FFFFFF'
10
  });
11
}, false);

1
using PSPDFKit.Model;
2
using PSPDFKit.UI;
3
using PSPDFKit.Instant;
4

5
var configuration = PSPDFConfiguration.FromConfigurationBuilder ((builder) => {
6
  builder.PageMode = PSPDFPageMode.Single;
7
  builder.PageTransition = PSPDFPageTransition.ScrollContinuous;
8
  builder.ScrollDirection = PSPDFScrollDirection.Vertical;
9
}));
10

11
var document = new PSPDFDocument (NSUrl.FromFilename ("document.pdf"));
12
var pdfViewController = new PSPDFViewController (document, configuration);

1
import { Component } from '@angular/core';
2
import { PSPDFKit } from '@ionic-native/pspdfkit/ngx';
3

4
@Component({
5
  selector: 'app-pdf',
6
  templateUrl: 'pdf.page.html'
7
})
8
export class PdfPage {
9
  constructor(private pspdfkit: PSPDFKit) {}
10

11
  openPDF() {
12
    this.pspdfkit.present('document.pdf', {
13
      pageTransition: 'scrollContinuous',
14
      scrollDirection: 'vertical'
15
    });
16
  }
17
}

1
using (GdPictureDocumentConverter oConverter = new GdPictureDocumentConverter())
2
{
3
  // Select the source document and its file format (DOCX, DOC, XLSX, XLS, PPTX, PPT).
4
  oConverter.LoadFromFile("input.docx", GdPicture14.DocumentFormat.DocumentFormatDOCX);
5
  // Convert the source document to PDF.
6
  oConverter.SaveAsPDF("output.pdf", PdfConformance.PDF);
7
}

1
Using oConverter As GdPictureDocumentConverter = New GdPictureDocumentConverter()
2
  'Select the source document and its file format (DOCX, DOC, XLSX, XLS, PPTX, PPT).
3
  oConverter.LoadFromFile("input.docx", GdPicture14.DocumentFormat.DocumentFormatDOCX)
4
  'Convert the source document to PDF.
5
  oConverter.SaveAsPDF("output.pdf", PdfConformance.PDF)
6
End Using

1
# You simply supply a list of document operations to apply.
2
curl -F file=@Example.pdf \
3
  -F operations='{"operations":[{"type": "flattenAnnotations"}]}' \
4
  http://localhost:5000/process \
5
  --output result.pdf

1
// Initialize PSPDFKit with your activation key.
2
PSPDFKit.initialize("YOUR_LICENSE_KEY_GOES_HERE");
3

4
// Open a document to work on.
5
File file = new File("assets/default.pdf");
6
PdfDocument document = new PdfDocument(new FileDataProvider(file));
7

8
// Add a new stamp annotation.
9
JSONObject jsonObject = new JSONObject();
10
jsonObject.put("bbox", new float[]{0, 0, 100, 50});
11
jsonObject.put("pageIndex", 0);
12
jsonObject.put("type", "pspdfkit/stamp");
13
jsonObject.put("stampType", "Approved");
14
jsonObject.put("opacity", 1);
15
jsonObject.put("v", 1);
16
document.getAnnotationProvider().addAnnotationJson(jsonObject);
17

18
// Export the changes to Instant Document JSON.
19
File jsonFile = new File("out/instantOutput.json");
20
if (jsonFile.createNewFile()) {
21
  document.exportDocumentJson(new FileDataProvider(jsonFile));
22
}
23

24
// Render the first page and save to a PNG.
25
BufferedImage image = document.getPage(0).renderPage();
26
File pngfile = new File("out/test.png");
27
boolean success = ImageIO.write(image, "png", pngfile);}

1
# You simply supply a list of document operations to apply.
2
curl -F file=@Example.pdf \
3
  -F operations='{"operations":[{"type": "flattenAnnotations"}]}' \
4
  http://localhost:5000/process \
5
  --output result.pdf

1
// This loads a PDF from `Assets` as soon as the `PdfView` is ready.
2
private async void PdfViewInitializationCompletedHandler(PdfView sender, Document args)
3
{
4
  try
5
  {
6
    var file = await StorageFile.GetFileFromApplicationUriAsync(new Uri("ms-appx:///Assets/document.pdf"));
7
    if (file == null) return;
8

9
    await sender.OpenStorageFileAsync(file);
10
  }
11
  catch (Exception e)
12
  {
13
    var messageDialog = new MessageDialog(e.Message);
14
    await messageDialog.ShowAsync();
15
  }
16
}
17

18
// This loads a PDF from a file picked by the user in the UI.
19
private async void Button_OpenPDF_Click(object sender, RoutedEventArgs e)
20
{
21
  // Open a `Picker` so the user can choose a PDF.
22
  var picker = new FileOpenPicker
23
  {
24
    ViewMode = PickerViewMode.Thumbnail,
25
    SuggestedStartLocation = PickerLocationId.DocumentsLibrary
26
  };
27
  picker.FileTypeFilter.Add(".pdf");
28

29
  var file = await picker.PickSingleFileAsync();
30
  if (file == null) return;
31

32
  // Open and display it in the PSPDFKit `PdfView`.
33
  var documentSource = DocumentSource.CreateFromStorageFile(file);
34
  await PdfView.Controller.ShowDocumentAsync(documentSource);
35
}

1
Imports Windows.Storage
2
Imports Windows.Storage.Pickers
3
Imports PSPDFKit.Document
4
Imports PSPDFKit.Pdf
5
Imports PSPDFKit.UI
6

7
Public NotInheritable Class MainPage
8
Inherits Page
9

10
Private Async Sub PdfViewInitializationCompletedHandler(sender As PdfView, args As Document)
11
Dim file As StorageFile
12
file = Await StorageFile.GetFileFromApplicationUriAsync(New Uri("ms-appx:///Assets/document.pdf"))
13

14
If file IsNot Nothing Then
15
Await sender.OpenStorageFileAsync(file)
16
End If
17
End Sub
18

19
Private Async Sub Button_OpenPDF_Click(sender As Object, e As RoutedEventArgs)
20
Dim picker As New FileOpenPicker
21
picker.FileTypeFilter.Add(".pdf")
22

23
Dim file = Await picker.PickSingleFileAsync
24
If file IsNot Nothing Then
25
Dim documentSource As DocumentSource
26
documentSource = DocumentSource.CreateFromStorageFile(file)
27
Await PdfView.Controller.ShowDocumentAsync(documentSource)
28
End If
29
End Sub
30
End Class

1
// This loads a PDF from `Assets` as soon as the `PdfView` is ready.
2
void MainPage::PdfViewInitializationCompletedHandler(UI::PdfView^ sender, Pdf::Document^ args)
3
{
4
  const auto path = ref new Uri("ms-appx:///Assets/document.pdf");
5

6
  create_task(StorageFile::GetFileFromApplicationUriAsync(path))
7
  .then([this](StorageFile^ file)
8
  {
9
    if (file == nullptr) return;
10

11
    PdfView->OpenStorageFileAsync(file);
12
  });
13
}
14

15
// This loads a PDF from a file picked by the user in the UI.
16
void MainPage::Button_OpenPDF_Click(Platform::Object^ sender, RoutedEventArgs^ e)
17
{
18
  // Open a `Picker` so the user can choose a PDF.
19
  FileOpenPicker^ openPicker = ref new FileOpenPicker();
20
  openPicker->ViewMode = PickerViewMode::Thumbnail;
21
  openPicker->SuggestedStartLocation = PickerLocationId::PicturesLibrary;
22
  openPicker->FileTypeFilter->Append(".pdf");
23

24
  create_task(openPicker->PickSingleFileAsync())
25
  .then([this](StorageFile^ file)
26
  {
27
    if (file == nullptr) return;
28

29
    // Open and display it in the PSPDFKit `PdfView`.
30
    const auto documentSource = DocumentSource::CreateFromStorageFile(file);
31
    PdfView->Controller->ShowDocumentAsync(documentSource);
32
  });
33
}

1
<Page
2
x:Class="BasicExample.MainPage"
3
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
4
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
5
xmlns:local="using:BasicExample"
6
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
7
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
8
xmlns:ui="using:PSPDFKit.UI"
9
mc:Ignorable="d"
10
Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
11
  <Page.Resources>
12
    <x:String x:Key="license">YOUR LICENSE GOES HERE</x:String>
13
  </Page.Resources>
14

15
  <Grid Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
16
    <Grid.RowDefinitions>
17
      <RowDefinition Height="*"/>
18
      <RowDefinition Height="52"/>
19
    </Grid.RowDefinitions>
20
    <ui:PdfView Grid.Row="0" Name="PdfView" License="{StaticResource license}" InitializationCompletedHandler="PdfViewInitializationCompletedHandler"/>
21
    <Button Content="Open PDF" HorizontalAlignment="Left" Margin="10" Grid.Row="1" Name="Button_OpenPDF" Click="Button_OpenPDF_Click"/>
22
  </Grid>
23
</Page>

1
import PSPDFKit
2
import PSPDFKitUI
3
import SwiftUI
4

5
// A Document is the container for your PDF file.
6
let document = Document(url: documentURL)
7

8
var body: some View {
9
  // A PDFView will present and manage the PSPDFKit UI.
10
  PDFView(document: document)
11
    .scrollDirection(.vertical)
12
    .pageTransition(.scrollContinuous)
13
    .pageMode(.single)
14
}

1
const { app, BrowserWindow } = require('electron');
2
const path = require('path');
3

4
function createWindow() {
5
  const mainWindow = new BrowserWindow({
6
    width: 1200,
7
    height: 800,
8
    webPreferences: {
9
      nodeIntegration: true,
10
      contextIsolation: false
11
    }
12
  });
13

14
  mainWindow.loadFile('index.html');
15
}
16

17
app.whenReady().then(createWindow);
18

19
// In your renderer process (index.html):
20
// <script>
21
// import PSPDFKit from 'pspdfkit';
22
//
23
// PSPDFKit.load({
24
//   container: '#pspdfkit',
25
//   document: 'document.pdf',
26
//   licenseKey: '<license-key>'
27
// });
28
// </script>

1
curl -X POST https://api.pspdfkit.com/build
2
  -H "Authorization: Bearer your_api_key_here"
3
  -o result.pdf
4
  -F index.html=@index.html
5
  -F instructions='{
6
      "parts": [
7
        { "html": "index.html" }
8
      ]
9
    }'

1
curl -X POST https://api.pspdfkit.com/build
2
  -H "Authorization: Bearer your_api_key_here"
3
  -o converted.pdf
4
  -F document=@Example1.docx
5
  -F instructions='{
6
      "parts": [
7
        { "file": "document" }
8
      ]
9
    }'

1
curl -X POST https://api.pspdfkit.com/build
2
  -H "Authorization: Bearer your_api_key_here"
3
  -o merged.pdf
4
  -F part1=@Example1.pdf
5
  -F part2=@Example2.pdf
6
  -F instructions='{
7
      "parts": [
8
        { "file": "part1" },
9
        { "file": "part2" }
10
      ]
11
    }'

1
curl -X POST https://api.pspdfkit.com/build
2
  -H "Authorization: Bearer your_api_key_here"
3
  -o result.pdf
4
  -F document=@Example.pdf
5
  -F instructions='{
6
      "parts": [
7
        { "file": "document" }
8
      ],
9
      "actions": [{
10
        "type": "ocr",
11
        "language": "english"
12
      }]
13
    }'