Nutrient

https://www.nutrient.io/guides/
Admin
Nutrient offers SDKs, cloud services, and low-code/workflow automation tools for developers and...
Tokens:1,384,723
Snippets:9,724
Trust Score:9.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Quick Start Guide PDF Samples (Swift & Objective-C)

Source: https://www.nutrient.io/guides/ios/samples

Essential code samples in Swift and Objective-C for getting started with PSPDFKit on iOS. Covers fundamental features to enhance app development.

```Swift
import PSPDFKit

// Example of initializing PSPDFKit
let document = PSPDFDocument(url: myPdfURL)
let viewController = PSPDFViewController(document: document)
// ... present viewController
```

--------------------------------

### iOS: Show PDFViewController in SwiftUI

Source: https://www.nutrient.io/guides/ios/samples

A basic guide on how to display a PDFViewController within a SwiftUI view hierarchy. It includes instructions and source code for initial setup.

```swift
import SwiftUI
import PSPDFKitUI

struct BasicPDFView: View {
    @State private var pdfDocument: PSPDFDocument?

    var body: some View {
        PDFViewSwiftUI(document: pdfDocument)
            .onAppear {
                // Load your PDF document here
                if let url = Bundle.main.url(forResource: "document", withExtension: "pdf") {
                    do {
                        self.pdfDocument = try PSPDFDocument(url: url)
                    } catch {
                        print("Error loading document: \(error)")
                    }
                }
            }
    }
}

struct BasicPDFView_Previews: PreviewProvider {
    static var previews: some View {
        BasicPDFView()
    }
}

```

--------------------------------

### Add Vite.js Integration Example

Source: https://www.nutrient.io/guides/web/release-notes/changelog

Includes a new example demonstrating how to integrate PSPDFKit with Vite.js, a modern front-end build tool. This facilitates easier project setup and development.

```javascript
// Example usage in a Vite.js project
import PSPDFKit from "pspdfkit";

PSPDFKit.load("document.pdf", "#viewer").then(instance => {
  console.log("PSPDFKit loaded successfully");
});
```

--------------------------------

### Example Additions and Changes

Source: https://www.nutrient.io/guides/web/release-notes/changelog

This section covers updates to the examples provided, including the addition of a TypeScript example and updates to the Electron example.

```APIDOC
## Example Additions and Changes

### Description
This section covers updates to the examples provided, including the addition of a TypeScript example and updates to the Electron example.

### Feature Additions

* **TypeScript Example**: Adds a TypeScript example. (#2394)

### Changes

* **Electron Example**: Updates PSPDFKit for Electron example to Electron 3. (#2098)
```

--------------------------------

### Example - PSPDFKit for Electron

Source: https://www.nutrient.io/guides/web/release-notes/changelog

Announces the addition of a new example demonstrating PSPDFKit for Electron.

```APIDOC
## Example - Electron Integration

### Description
Adds the new PSPDFKit for Electron example, showcasing integration with the Electron framework.

### Method
N/A (Example provided)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Illustrate SDK Usage in iOS Playground (Swift)

Source: https://www.nutrient.io/guides/ios/samples/playground

This Swift code sample demonstrates how to use the PSPDFKit SDK within an iOS Playground. Users should adapt this example to their specific integration requirements. It serves as a basic illustration of SDK functionality.

```swift
// PLAYGROUNDEXAMPLE.SWIFT
// This code sample is an example that illustrates how to use our SDK.
// Please adapt it to your specific use case.

```

--------------------------------

### PDF Streaming for On-Demand Document Loading in Swift

Source: https://www.nutrient.io/guides/ios/samples

Explore how to load document parts on demand using Swift. This guide includes code samples and practical examples for streaming documents and views.

```Swift
// Swift example for PDF streaming (on-demand loading).
// This is a placeholder and would contain actual implementation details.
console.log("PDF Streaming in Swift.");
```

--------------------------------

### Manage PDFViewController State with Swift Examples

Source: https://www.nutrient.io/guides/ios/samples

Explore the different states of PDFViewController with Swift examples. This resource helps you understand and customize the behavior of your PDF viewer based on its current state.

```swift
import PSPDFKit

// Accessing state properties:
// let currentPageIndex = pdfViewController.currentPageIndex
// let zoomScale = pdfViewController.zoomScale
// let isDocumentOpen = pdfViewController.isDocumentOpen

```

--------------------------------

### Update README for Easier Getting Started

Source: https://www.nutrient.io/guides/flutter/changelog

Updates the README file to provide simpler example code and more accessible getting started instructions.

```dart
// Updates the `README` for easier getting started instructions and simpler example code. (#28303)
```

--------------------------------

### PDF Streaming with Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn to load document parts on demand using Swift for efficient PDF streaming. This guide provides code samples and practical examples for managing large documents.

```swift
// Example Swift code for PDF streaming (loading parts on demand)
// Covers efficient document loading and view management.
```

--------------------------------

### Popover Presentation with Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to customize the PDFViewController using a popover presentation with Swift. This guide provides a code example for effective implementation.

```Swift
// Code example for popover presentation with Swift
```

--------------------------------

### OpenTelemetry Exporting Setup (Helm)

Source: https://www.nutrient.io/guides/document-engine/monitoring/opentelemetry

This example demonstrates how to configure OpenTelemetry exporting using the Helm chart's observability section. It assumes a standard Helm deployment pattern.

```yaml
observability:
  opentelemetry:
    # Add OpenTelemetry specific configurations here
```

--------------------------------

### Create Settings View with SwiftUI

Source: https://www.nutrient.io/guides/ios/samples

Use PDFViewController in SwiftUI to create a custom settings interface for PDF viewing. This guide provides step-by-step examples and source code.

```swift
// Example SwiftUI code for a custom PDF settings view
// Enables user-configurable options for PDF display and behavior.
```

--------------------------------

### Display PDF Annotations on Layers in Swift

Source: https://www.nutrient.io/guides/ios/samples

Discover how to use Instant’s Layers feature for PDF document annotations. This guide provides resources and a practical example in Swift.

```swift
let pdfDocument = PSPDFDocument(url: pdfURL)
pdfDocument.layersEnabled = true
// Annotations can now be organized into layers
```

--------------------------------

### Clone Node.js Example Project

Source: https://www.nutrient.io/guides/document-engine/example-projects

This command clones the Node.js example project from the repository. Ensure Git is installed if the command fails.

```Shell
git clone https://github.com/PSPDFKit/node-starter-project.git
cd node-starter-project
```

--------------------------------

### Update React and Webpack Example Apps

Source: https://www.nutrient.io/guides/web/release-notes/changelog

Updates React and Webpack example applications to work with the new `pspdfkit-lib` asset directory.

```javascript
Update React and Webpack example apps
```

--------------------------------

### PDFViewController Controller State in Swift

Source: https://www.nutrient.io/guides/ios/samples

Explore the different states of PDFViewController with Swift examples. Visit the API guide for more resources on customizing your PDF viewer.

```swift
// Example of accessing PDFViewController state
// let currentState = pdfViewController.state
// switch currentState {
// case .loading:
//     print("Document is loading")
// case .ready:
//     print("Document is ready")
// default:
//     break
// }
```

--------------------------------

### PDF Streaming with SwiftUI

Source: https://www.nutrient.io/guides/ios/samples

Optimize app performance by loading document parts on demand in SwiftUI using PSPDFKit's streaming capabilities. This guide includes source code and practical examples.

```swift
// Example SwiftUI code for PDF streaming (loading parts on demand)
// Focuses on efficient document loading for large files.
```

--------------------------------

### Clone Ruby on Rails Example Project

Source: https://www.nutrient.io/guides/document-engine/example-projects

This command clones the Ruby on Rails example project from the repository. Ensure Git is installed if the command fails.

```Shell
git clone https://github.com/PSPDFKit/rails-starter-project.git
cd rails-starter-project
```

--------------------------------

### Add Download Buttons to PWA and Catalog Examples

Source: https://www.nutrient.io/guides/web/release-notes/changelog

Enhances the PWA and Catalog examples by adding download buttons, likely for sample documents or generated PDFs. This improves the user experience for trying out the examples.

```JavaScript
Adds download buttons to the PWA and Catalog examples.
```

--------------------------------

### Customize Link Annotations in Swift with PSPDFKit

Source: https://www.nutrient.io/guides/ios/samples

Discover how to customize link annotations in iOS with PSPDFKit. This guide provides comprehensive API details and code examples for implementation.

```swift
let linkAnnotation = PSPDFLinkAnnotation()
linkAnnotation.URL = URL(string: "https://pspdfkit.com")
linkAnnotation.rect = CGRect(x: 50, y: 50, width: 100, height: 30)
viewController.add(annotation: linkAnnotation)
```

--------------------------------

### Show Multiple Documents Using Tabs (Swift)

Source: https://www.nutrient.io/guides/ios/samples

Discover how to implement a tabbed interface in iOS to open and manage multiple PDF documents. This guide includes a Swift code example.

```swift
// Example Swift code for a tabbed interface to show multiple PDF documents
// Manages multiple PDF documents within a single interface.
```

--------------------------------

### Examples API Updates

Source: https://www.nutrient.io/guides/web/release-notes/changelog

Information on updates to example integrations, including Angular, Vue, and TypeScript projects, and fixes for Webpack examples.

```APIDOC
## Integration Examples Update

### Description
Provides updated examples for integrating PSPDFKit for Web with Angular, Vue, and TypeScript projects, including Annotation API usage.

### Method
GET

### Endpoint
/api/examples/integrations

### Response
#### Success Response (200)
- **message** (string) - Confirmation of example updates.

#### Response Example
```json
{
  "message": "Integration examples updated."
}
```
```

```APIDOC
## Webpack Example Fix

### Description
Fixes an issue in the Webpack example where loading a document would fail.

### Method
GET

### Endpoint
/api/examples/webpack-fix

### Response
#### Success Response (200)
- **status** (string) - Indicates success.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Example Bug Fixes

Source: https://www.nutrient.io/guides/web/release-notes/changelog

This section details a bug fix in the examples, specifically addressing a layout issue in the PWA example.

```APIDOC
## Example Bug Fixes

### Description
This section details a bug fix in the examples, specifically addressing a layout issue in the PWA example.

### Fixed Issues

* **PWA Example Layout**: Fixes a layout issue in the PWA example. (#2351)
```

--------------------------------

### Get Ingress Hostname with kubectl

Source: https://www.nutrient.io/guides/document-engine/deployment/ingress

This command retrieves the hostname for the Ingress controller, which is necessary for DNS configuration. It expects the Kubernetes client (kubectl) to be installed and configured to access the cluster.

```bash
kubectl get ingress -o jsonpath='{.items[0].spec.rules[0].host}'
```

--------------------------------

### Implement Custom PDF Bookmark Provider in iOS with Swift

Source: https://www.nutrient.io/guides/ios/samples

Implement a custom bookmark provider in iOS using a plist file. This guide offers additional resources and Swift code examples for flexible bookmark management.

```swift
import PSPDFKit

class CustomBookmarkProvider: BookmarkProvider {
    // Implement methods to load bookmarks from a plist or other source
}

// Usage:
// pdfViewController.bookmarkManager.bookmarkProvider = CustomBookmarkProvider()
```

--------------------------------

### Creating Annotation.Tool and Annotation.Kind (Swift)

Source: https://www.nutrient.io/guides/ios/migration-guides/pspdfkit-9-3-migration-guide

Shows the recommended way to initialize Annotation.Tool from its kind and vice versa, replacing removed helper functions.

```Swift
// For creating Annotation.Tool from Annotation.Kind:
let tool = Annotation.Tool(kind: .text)

// For creating Annotation.Kind from Annotation.Tool:
let kind = Annotation.Kind(tool: .underline)
```

--------------------------------

### Add Analytics to PDF Components in iOS

Source: https://www.nutrient.io/guides/ios/samples

Example implementation of `PDFAnalyticsClient` that logs events to the console. Get additional resources by visiting the guide on iOS PDF viewer analytics.

```swift
// Example of logging analytics events
// let analyticsClient = PDFAnalyticsClient.shared
// analyticsClient.log("annotation_added", parameters: ["type": "text"])
```

--------------------------------

### Set up PSPDFKit for E-Learning (LMS) in Swift

Source: https://www.nutrient.io/guides/ios/samples

Discover how to set up PSPDFKit for e-learning exams and grading. Explore additional resources in our blog on grading papers in an LMS application.

```swift
// Example code for e-learning (LMS) setup
```

--------------------------------

### Start PdfActivity Without PDF Loaded in Kotlin

Source: https://www.nutrient.io/guides/android/samples

Learn to initiate a PdfActivity without a PDF document. This guide includes a Kotlin example and resources for customizing your PDF interface.

```kotlin
 // Example code for starting PdfActivity without PDF loaded in Kotlin. 
 // Specific code not provided in the input text.
```

--------------------------------

### Set up PSPDFKit as an E-Reader in iOS

Source: https://www.nutrient.io/guides/ios/samples

Provides a Swift example for setting up PSPDFKit as a functional e-reader application. This covers basic PDF viewing and navigation functionalities.

```swift
/*
 * Example code for setting up PSPDFKit as an e-reader in iOS.
 * This focuses on core functionalities like document loading and viewing.
 */
// let pdfViewController = PDFViewController(document: pdfDocument)
// // Present or push pdfViewController onto the navigation stack

```

--------------------------------

### Link Annotation Examples in iOS

Source: https://www.nutrient.io/guides/ios/samples

Learn to create link annotations for iOS that point to pages, documents, and websites with external media support.

```swift
// Example of creating a Link Annotation to a URL
// let linkAnnotation = PSPDFLinkAnnotation(frame: CGRect(x: 50, y: 50, width: 100, height: 30))
// linkAnnotation.URI = "https://example.com"
// pdfDocument.add(linkAnnotation)
```

--------------------------------

### Set up PSPDFKit as PDF E-Reader in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to set up PSPDFKit as an e-reader with our Swift example. Explore more resources in our blog article on building an e-reader app.

```swift
// Example code for setting up PSPDFKit as an e-reader
```

--------------------------------

### Annotate on Image Documents in iOS

Source: https://www.nutrient.io/guides/ios/samples

Load an image file from a local folder to use with PDF annotation tools. Get additional resources by visiting the guide on adding annotations to images.

```swift
// Example of loading an image for annotation
// if let imageURL = Bundle.main.url(forResource: "sampleImage", withExtension: "jpg") {
//     let pdfDocument = PDFDocument(url: imageURL)
//     pdfViewController.setDocument(pdfDocument)
// }
```

--------------------------------

### Annotation Overlay Mode in Android

Source: https://www.nutrient.io/guides/android/samples

An example showing how to draw annotations as overlay views instead of rendering them as part of the page using Java. Get additional resources by visiting the guide.

```Java
/*
 * Example code demonstrating annotation overlay mode in Android using Java.
 * This snippet shows how annotations are drawn as overlay views.
 */

// Placeholder for actual Java code
// public void enableAnnotationOverlay(PdfViewer viewer) {
//     // Code to enable overlay mode for annotations
// }

```

--------------------------------

### Create Bookmark UI in iOS

Source: https://www.nutrient.io/guides/ios/samples

Learn to build a UI for creating named bookmarks in iOS using Swift. Includes code examples and resources for bookmark implementation.

```swift
// Example code for bookmark UI in iOS
// This is a placeholder and would contain actual Swift code.
```

--------------------------------

### Fix Webpack Example Document Loading Failure

Source: https://www.nutrient.io/guides/web/release-notes/changelog

Resolves an issue in the Webpack example where loading a document would result in a failure. This fix ensures that documents can be loaded correctly in the Webpack setup.

```javascript
Webpack Example Fix
```

--------------------------------

### Handle Password-Protected PDFs with Built-In UI in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to handle password-protected PDFs in iOS using the built-in UI. Get tips for bypassing password prompts and explore useful Swift code examples.

```swift
let pdfDocument = PSPDFDocument(url: protectedURL)
pdfViewController.presentPasswordEntryAlert(for: pdfDocument)
```

--------------------------------

### Start PdfActivity without PDF Loaded in Kotlin

Source: https://www.nutrient.io/guides/android/samples/empty-activity-kotlin

This Kotlin code snippet demonstrates how to launch an Android PdfActivity without initially loading a PDF. It's a foundational example for integrating the SDK.

```kotlin
import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main) // Assuming you have a layout file

        // Example of starting PdfActivity without a PDF loaded
        // Replace 'PdfActivity' with the actual name of your PDF activity class
        // val intent = Intent(this, PdfActivity::class.java)
        // startActivity(intent)
    }
}
```

--------------------------------

### Customize PDF Sharing Options in iOS with Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to customize document sharing options in iOS. This guide provides a Swift code example to enhance your app's document sharing capabilities.

```swift
import UIKit
import PSPDFKit

// Customizing sharing options often involves intercepting the share action
// and modifying the UIActivityViewController or its data.
```

--------------------------------

### Get PdfDocumentCheckpointer

Source: https://www.nutrient.io/guides/android/features/document-checkpointing

Retrieves the checkpointer instance for a given PdfDocument to manage checkpoints. This is the starting point for configuring checkpointing behavior.

```java
PdfDocumentCheckpointer checkpointer = pdfDocument.getCheckpointer();
```

--------------------------------

### Vue 3 Compatible Example for PSPDFKit

Source: https://www.nutrient.io/guides/web/release-notes/changelog

A new example has been added to the Vue.js example repository, specifically designed to be compatible with Vue 3 projects utilizing PSPDFKit.

```javascript
// Vue 3 example setup for PSPDFKit
// This would showcase how to initialize and use PSPDFKit within a Vue 3 application.
```

--------------------------------

### Integrate PSPDFKit for Web with Nuxt.js

Source: https://www.nutrient.io/guides/web/release-notes/changelog

This example demonstrates how to integrate PSPDFKit for Web into a Nuxt.js project, providing guidance on setup and usage within the Nuxt.js framework.

```javascript
// Nuxt.js integration example
// This would typically involve setting up PSPDFKit in a Vue component within Nuxt.
```

--------------------------------

### Initialize Helm Values File (Simple)

Source: https://www.nutrient.io/guides/document-engine/deployment/helm

Copies the basic 'values.simple.yaml' file from the Document Engine Helm chart. This file provides a starting configuration for a PostgreSQL-backed deployment.

```bash
helm show values document-engine/document-engine -d > values.simple.yaml
```

--------------------------------

### Start PdfActivity without Loaded PDF (Kotlin)

Source: https://www.nutrient.io/guides/android/samples

Learn to initiate a PdfActivity without a pre-loaded PDF document. Includes Kotlin example and resources for interface customization.

```Kotlin
This guide covers the process of launching a PdfActivity in an Android application without requiring an initial PDF document to be loaded. It aims to provide flexibility in how the PDF interface is presented to the user. A Kotlin example is included, along with resources to assist in customizing the PDF interface for different use cases.
```

--------------------------------

### Activate Document Engine License (Shell)

Source: https://www.nutrient.io/guides/document-engine/example-projects

This command adds an activation key to Docker to activate Document Engine. Omit this step to run in trial mode. This is for Unix-like systems.

```Shell
export PSPDFKIT_ACTIVATION_KEY=<your_activation_key>
```

--------------------------------

### Example API Changes

Source: https://www.nutrient.io/guides/web/release-notes/changelog

Details changes made to the example applications, such as adding download buttons and updating dependencies.

```APIDOC
## Example API Changes

### Description
Adds download buttons to the PWA and Catalog examples. Fixes an issue with the iOS iPad full screen demo in the magazine catalog example. Upgrades React example to latest versions.

### Method
N/A (Example application changes)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A (Example updates)

#### Response Example
N/A
```

--------------------------------

### Add Custom View Controller for Screen Mirroring in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to add your own view controller for screen mirroring in Swift. Explore example code and customize your app's display seamlessly.

```Swift
// Code example for adding a custom view controller for screen mirroring
```

--------------------------------

### Custom Sidebar Lifecycle Methods

Source: https://www.nutrient.io/guides/web/user-interface/ui-customization/custom-sidebars

Provides an example of using `onMount` and `onUnmount` lifecycle methods for custom sidebars. `onMount` is for setup actions, and `onUnmount` is for cleanup actions.

```javascript
myCustomSidebar: () => ({
  render: () => /* custom sidebar UI */,
  onMount: () => {
    console.log("Custom sidebar mounted");
    // Add event listeners or analytics here
  },
  onUnmount: () => {
    console.log("Custom sidebar unmounted");
    // Remove event listeners or perform cleanup here
  }
})
```

--------------------------------

### Search PDF Text Programmatically on iOS with Swift Example

Source: https://www.nutrient.io/guides/ios/samples

Discover how to search text in PDFs programmatically on iOS. This guide provides resources and a Swift example to enhance your app's search functionality.

```Swift
// Swift example for programmatic PDF text search.
// This is a placeholder and would contain actual implementation details.
console.log("Programmatic PDF text search.");
```

--------------------------------

### Build Bookmark Creation UI in iOS with Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn to build a user interface for creating named bookmarks in iOS. This Swift code example and additional resources facilitate bookmark implementation within your PDF viewer.

```swift
import PSPDFKit

// Creating a bookmark:
// let bookmark = PSPDFBookmark(title: "Chapter 1", page: 0)
// document.addBookmark(bookmark)
```

--------------------------------

### Nutrient Catalog: Multimedia Annotations (Swift)

Source: https://www.nutrient.io/guides/ios/getting-started/example-projects

Demonstrates handling multimedia annotations like videos and GIFs within the Nutrient Catalog example project.

```swift
// Example for Multimedia annotations like videos and GIFs
// This involves creating or processing annotations that embed media.

/*
 // Creating a multimedia annotation might involve:
 let annotation = MultimediaAnnotation(rect: CGRect(x: 100, y: 100, width: 50, height: 50), mediaURL: URL(string: "video.mp4"))
 // Add annotation to a PDF page
 // pdfPage.addAnnotation(annotation)
 */
```

--------------------------------

### OCR Using PHP

Source: https://www.nutrient.io/guides/document-converter/document-converter-services/ocr/php

This snippet demonstrates how to perform OCR using the PHP SDK. It's a basic example showing the initial setup and a core function call. Dependencies include the OCR SDK.

```php
<?php

// Include the required files
require_once 'vendor/autoload.php';

use OCR\OCRClient;

// Replace with your API key
$apiKey = 'YOUR_API_KEY';
$client = new OCRClient($apiKey);

// Path to the image file
$filePath = 'path/to/your/image.png';

// Perform OCR
try {
    $result = $client->ocr($filePath);
    print_r($result);
} catch (Exception $e) {
    echo 'Error: ' . $e->getMessage();
}

?>
```

--------------------------------

### Configure ingress-nginx for HTTP Access

Source: https://www.nutrient.io/guides/document-engine/deployment/ingress

This YAML snippet configures the ingress-nginx controller in Kubernetes to expose Document Engine at a specified hostname. It requires a Helm installation of Document Engine and a valid Helm values file.

```yaml
ingress:
  enabled: true
  className: nginx
  annotations:
    nginx.ingress.kubernetes.io/rewrite-target: /
  hosts:
    - host: de.example.com
      paths:
        - path: /
          pathType: ImplementationSpecific
```

--------------------------------

### Create PAdES Digital Signatures in iOS with Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to prepare documents for PAdES digital signatures. This Swift code example demonstrates contained signatures, providing essential iOS resources and guidance for secure document signing.

```swift
import PSPDFKit

// Example for setting up PAdES signature
// let signature = try? PSPDFSignature(data: signatureData, format: .pades)
// annotation.signature = signature
```

--------------------------------

### Activate Document Engine License (Windows CMD)

Source: https://www.nutrient.io/guides/document-engine/example-projects

This command adds an activation key to Docker to activate Document Engine. Omit this step to run in trial mode. This is for Windows Command Prompt.

```Shell
set PSPDFKIT_ACTIVATION_KEY=<your_activation_key>
```

--------------------------------

### Enable Automatic TLS with cert-manager Annotation

Source: https://www.nutrient.io/guides/document-engine/deployment/ingress

This YAML snippet shows how to enable automatic TLS certificate management using cert-manager by adding a specific annotation to the ingress resource. It assumes cert-manager is installed with a named issuer.

```yaml
ingress:
  enabled: true
  className: nginx
  annotations:
    cert-manager.io/issuer: "my-tls-issuer"
  hosts:
    - host: de.example.com
      paths:
        - path: /
          pathType: ImplementationSpecific
```

--------------------------------

### Set up PSPDFKit for E-Learning Exams in iOS

Source: https://www.nutrient.io/guides/ios/samples

This example focuses on configuring PSPDFKit for e-learning platforms, specifically for handling exams and grading. It leverages PSPDFKit's annotation features for interactive assessments.

```swift
/*
 * Example code for setting up PSPDFKit in an e-learning context for exams.
 * This involves utilizing annotation functionalities for grading and student interaction.
 */
// Specific implementation details would depend on the LMS integration.
// This might involve custom annotation types or data handling.

```

--------------------------------

### Activate Document Engine License (PowerShell)

Source: https://www.nutrient.io/guides/document-engine/example-projects

This command adds an activation key to Docker to activate Document Engine. Omit this step to run in trial mode. This is for Windows PowerShell.

```Shell
$env:PSPDFKIT_ACTIVATION_KEY='<your_activation_key>'
```

--------------------------------

### Customize the Annotation Inspector in iOS

Source: https://www.nutrient.io/guides/ios/samples

Learn to customize the iOS annotation inspector for vector stamp annotations with blend modes. Explore the guide for more resources and examples.

```swift
// Example of customizing annotation inspector appearance
// pdfViewController.annotationInspectorViewController.appearanceMode = .dark
// pdfViewController.annotationInspectorViewController.delegate = self
```

--------------------------------

### Example API Updates

Source: https://www.nutrient.io/guides/web/release-notes/changelog

Details new catalog examples for Document Editor and dark mode, and a fix for toolbar items in custom documents.

```APIDOC
## POST /api/examples/catalog/documentEditor

### Description
Adds a new catalog example for the Document Editor.

### Method
POST

### Endpoint
/api/examples/catalog/documentEditor

### Parameters
#### Request Body
- **exampleName** (String) - Required - Name of the new example.

### Request Example
{
  "exampleName": "DocumentEditorBasic"
}

### Response
#### Success Response (200)
- **status** (String) - Operation status.

#### Response Example
{
  "status": "added"
}
```

```APIDOC
## POST /api/examples/catalog/darkMode

### Description
Adds a new catalog example demonstrating dark mode.

### Method
POST

### Endpoint
/api/examples/catalog/darkMode

### Parameters
#### Request Body
- **exampleName** (String) - Required - Name of the new example.

### Request Example
{
  "exampleName": "DarkModeTheme"
}

### Response
#### Success Response (200)
- **status** (String) - Operation status.

#### Response Example
{
  "status": "added"
}
```

```APIDOC
## POST /api/examples/customDocuments/toolbarItems

### Description
Fixes an issue where custom documents did not have the same toolbar items as example documents.

### Method
POST

### Endpoint
/api/examples/customDocuments/toolbarItems

### Parameters
#### Request Body
- **documentType** (String) - Required - The type of custom document.

### Request Example
{
  "documentType": "custom"
}

### Response
#### Success Response (200)
- **status** (String) - Operation status.

#### Response Example
{
  "status": "fixed"
}
```

--------------------------------

### Disable Bookmark Editing in PDFs (Swift)

Source: https://www.nutrient.io/guides/ios/samples

Learn how to disable bookmark editing in PDFs using a Swift example. Explore more on document features in comprehensive guides.

```swift
// Example code for disabling bookmark editing
// This snippet provides a Swift example to prevent users from editing bookmarks within a PDF.
// It ensures that bookmarks remain static.

// Placeholder for actual Swift code
print("Disabling bookmark editing...")
```

--------------------------------

### Initialize and Use Document Class with Try-with-Resources

Source: https://www.nutrient.io/guides/java/conversion/powerpoint-document-to-pdf

Demonstrates initializing the Nutrient SDK's Document class using a try-with-resources statement for proper lifecycle management and loading a PPTX file.

```java
try (Document document = new Document("example.pptx")) {
    // Operations on the document
}
```

--------------------------------

### Customize PSPDFNoteAnnotationViewController in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn to hide timestamp and author labels in PSPDFNoteAnnotationViewController. This guide provides access to the API and example code for seamless customization of note annotations.

```swift
// Example code for customizing PSPDFNoteAnnotationViewController
```

--------------------------------

### Minimal Example: Basic Nutrient Integration (Swift)

Source: https://www.nutrient.io/guides/ios/getting-started/example-projects

Shows a minimal Nutrient integration in a basic iOS application using Swift. Includes simple use cases for `Processor` and `PDFLibrary`.

```swift
// Minimal Nutrient integration example in Swift

/*
 import Nutrient

 // Basic usage of PDFLibrary
 let pdfLibrary = PDFLibrary()
 let document = pdfLibrary.loadDocument(atPath: "path/to/your/document.pdf")

 // Basic usage of Processor
 let processor = Processor()
 // Perform some processing...
 */
```

--------------------------------

### Disable Bookmark Editing in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to disable bookmark editing in PDFs using a Swift example. This guide explores more on document features and effective bookmark management in iOS.

```swift
// Example code for disabling bookmark editing
```

--------------------------------

### Create PDFViewController using Storyboard (Swift)

Source: https://www.nutrient.io/guides/ios/samples

Step-by-step guide on creating a PDFViewController using a storyboard in Swift. This simplifies the integration of PDF viewing capabilities into iOS apps.

```swift
// Example Swift code for integrating PDFViewController via Storyboard
// Demonstrates IBOutlet and segue connections for seamless UI setup.
```

--------------------------------

### Use Custom Page Label Formatter in iOS

Source: https://www.nutrient.io/guides/ios/samples

Learn to customize page labels in your document view using Swift. Includes a Swift example and the PSPDFPageLabelFormatter API guide.

```swift
// Example code for custom page label formatter in iOS
// This is a placeholder and would contain actual Swift code.
```

--------------------------------

### Initialize Nutrient with AndroidManifest.xml (Kotlin)

Source: https://www.nutrient.io/guides/android/migration-guides/pspdfkit-3-migration-guide

Demonstrates how to configure Nutrient initialization by adding a meta-data tag to the AndroidManifest.xml file for automatic setup.

```xml
<meta-data android:name="nutrient_license_key" android:value="YOUR_LICENSE_KEY" />
```

--------------------------------

### Showcase Annotation Rendered Content Customization Example

Source: https://www.nutrient.io/guides/web/release-notes/changelog

Presents a new Catalog Example that highlights how to customize the rendered content of annotations, offering more control over annotation appearance.

```javascript
// Example for customizing annotation rendering.
```

--------------------------------

### Enable Auto-Save with PDF Checkpointing in iOS

Source: https://www.nutrient.io/guides/ios/samples

Discover how to auto save documents using the checkpointing API. Access the iOS guide for additional resources and Swift code examples.

```swift
// Example of enabling auto-save with checkpointing
// pdfDocument.isAutoSaveEnabled = true
// pdfDocument.checkpointingInterval = 60 // Save every 60 seconds
```

--------------------------------

### Search and Redact Text in PDF Documents with Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to search and redact text in PDF documents with a Swift example. Explore the guide for more on iOS PDF redaction techniques.

```Swift
// Code example for searching and redacting text in PDF documents
```

--------------------------------

### Implement Different Print Modes Example

Source: https://www.nutrient.io/guides/web/release-notes/changelog

Adds a new Catalog Example showcasing the usage of different print modes available within the viewer, allowing customization of print output.

```javascript
// Example code for various print modes.
```

--------------------------------

### SwiftUI Document Browser: Open and Create PDFs (Swift)

Source: https://www.nutrient.io/guides/ios/getting-started/example-projects

Demonstrates how to display a document browser in SwiftUI, enabling users to open and create PDF documents using the Nutrient library.

```swift
// SwiftUI Document Browser example using Nutrient

/*
 import SwiftUI
 import Nutrient

 struct DocumentBrowserView: View {
     @State private var documents: [DocumentMetadata] = [] // Assume DocumentMetadata struct exists

     var body: some View {
         NavigationView {
             List(documents) {
                 DocumentRow(document: $0) // Assume DocumentRow View exists
             }
             .navigationTitle("My Documents")
             .toolbar {
                 Button("New") { createNewDocument() } // Action to create a new document
             }
         }
     }

     func createNewDocument() {
         // Logic to create a new PDF document using Nutrient
         print("Creating new document...")
     }
 }
 */
```

--------------------------------

### Programmatically Go To PDF Outline Item in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to programmatically access specific document outline items in Swift. The guide provides resources and examples for outline navigation.

```Swift
// Code example for programmatically going to a PDF outline item
```

--------------------------------

### Open Password-Protected PDFs with Preset Password in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to unlock password-protected PDFs in iOS with Swift. The guide offers detailed resources and examples to streamline document security.

```Swift
// Code example for opening password-protected PDFs with preset password
```

--------------------------------

### Create PDFViewController using Storyboard in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to create a PDFViewController using a storyboard in Swift. Follow the step-by-step guide and access source files for easy implementation.

```Swift
// Swift code for creating a PDFViewController using a storyboard.
// This is a placeholder and would contain actual implementation details.
console.log("Create PDFViewController from Storyboard.");
```

--------------------------------

### Automatically Select and Edit Free Text Annotations in Swift

Source: https://www.nutrient.io/guides/ios/samples

This Swift example shows how to automatically select and edit Free Text Annotations. Explore the PSPDFDocument API guide for more resources.

```Swift
// Swift example for selecting and editing Free Text Annotations.
// This is a placeholder and would contain actual implementation details.
console.log("Auto-select and edit Free Text Annotations.");
```

--------------------------------

### Search and Redact Text in PDF Documents with Swift

Source: https://www.nutrient.io/guides/ios/samples

This Swift example demonstrates how to search and redact text within PDF documents. Explore the guide for more on iOS PDF redaction techniques.

```Swift
 // Example code for searching and redacting text in PDF documents
 // This is a placeholder and would contain actual implementation details.
 console.log("Search and redact text functionality.");
```

--------------------------------

### Load SDK with Custom Toolbar Items using JavaScript

Source: https://www.nutrient.io/guides/web/user-interface/main-toolbar/create-a-new-tool

Shows how to initialize the Nutrient.io SDK with a custom list of toolbar items. This approach is used when the desired toolbar configuration is known at the time of loading the SDK.

```javascript
NutrientViewer.load("#viewer-container", {
  toolbar: {
    items: [
      NutrientViewer.defaultToolbarItems.zoomIn,
      NutrientViewer.defaultToolbarItems.zoomOut,
      myCustomItem // Your custom item
    ]
  }
});
```

--------------------------------

### Board Meeting Collaboration Example using PSPDFKit Instant

Source: https://www.nutrient.io/guides/ios/samples

Learn to create or join collaborative board meeting sessions using PSPDFKit Instant. Explore resources for enhancing PDF collaboration.

```swift
// Example of initiating a collaboration session
// PSPDFInstant.shared?.createSession { sessionId in
//     print("Collaboration session created: \(sessionId)")
// }
```

--------------------------------

### Display Measurements on PDF Pages or Spreads in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to add auxiliary views to spreads/pages in your iOS app. This guide explores the PDFPageView API and provides example codes for customization.

```swift
let measurementView = UIView(frame: CGRect(x: 0, y: 0, width: 50, height: 50))
pdfPageView.insertSubview(measurementView, at: 0)
// Add measurement logic to measurementView
```

--------------------------------

### Configure PDF Annotation Toolbar Manually in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn to manually configure the annotation toolbar in iOS without UINavigationController. This guide provides additional resources and examples for toolbar customization.

```swift
let annotationToolbar = PSPDFAnnotationToolbar.sharedInstance()
annotationToolbar.addToolbarItem(for: .highlight)
annotationToolbar.setToolbarItems([.highlight, .underline])
```

--------------------------------

### Create Free Text Annotations Continuously in iOS with Swift

Source: https://www.nutrient.io/guides/ios/samples

Streamline the creation of Free Text annotations in iOS. This guide focuses on the annotation state manager for efficient multi-annotation workflows, enhancing productivity.

```swift
import PSPDFKit

// To enable continuous free text annotation:
// pdfViewController.annotationManager.isContinuousFreeTextAnnotationEnabled = true
```

--------------------------------

### Disable PDF Annotation Editing in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to use annotation flags to disable editing in iOS. This guide provides Swift code examples for effective implementation of read-only annotations.

```swift
// Example code for disabling PDF annotation editing
```

--------------------------------

### Sign Document with PSPDFKit (Frontend)

Source: https://www.nutrient.io/guides/web/signatures/digital-signatures/integrations/aws-hsm

Provides an example of initiating the document signing process from a frontend application using the PSPDFKit library. It calls the instance.signDocument API, which is the primary method for starting signature operations within the SDK.

```javascript
PSPDFKit.instance.signDocument(...);
```

--------------------------------

### Contained PAdES Digital Signature in iOS (Swift)

Source: https://www.nutrient.io/guides/ios/samples

Learn how to prepare documents for PAdES digital signatures. Access the guide for iOS resources and a Swift code example for contained signatures.

```swift
// Example of preparing for PAdES digital signature
// // Ensure document meets PAdES requirements
// // Use PSPDFSignature signatureType property for PAdES settings
```

--------------------------------

### Embed PSPDFKit as Child View Controller in iOS

Source: https://www.nutrient.io/guides/ios/samples

Learn how to embed a PDFViewController as a child view controller in iOS. This guide provides detailed resources and Swift code examples for integration.

```swift
// Example of embedding PDFViewController as a child view controller
// let pdfVC = PDFViewController()
// addChildViewController(pdfVC)
// view.addSubview(pdfVC.view)
// pdfVC.didMove(toParentViewController: self)
```

--------------------------------

### Initialize PSPDFKit with Context and InitializationOptions

Source: https://www.nutrient.io/guides/android/migration-guides/pspdfkit-2024-2-migration-guide

This snippet demonstrates the new way to initialize PSPDFKit using a `Context` and optional `InitializationOptions`. It replaces older, deprecated methods.

```kotlin
PSPDFKit.initialize(context: Context, options: InitializationOptions? = null)
```

--------------------------------

### Show or Hide All PDF Annotations (Swift)

Source: https://www.nutrient.io/guides/ios/samples

Learn to programmatically hide or show all annotations in a PDF document using Swift. This guide provides a code example for effective annotation management.

```swift
// Example Swift code to show or hide all PDF annotations
// Provides control over the visibility of annotations within a PDF.
```

--------------------------------

### Show Author Name on Annotation Selection in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to display author names on annotation selection in PSPDFKit using Swift. Explore the example and visit the PSPDFAnnotation API guide.

```Swift
// Code example for showing author name on annotation selection
```

--------------------------------

### Initialize PDF with Data in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to create a PDF document in-memory using Swift. Visit our guide for more on opening PDFs from in-memory data in iOS applications.

```swift
// Example code for initializing a PDF with data
```

--------------------------------

### Temporarily Rotate PDF Page in 90-Degree Increments with Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn to rotate PDF pages temporarily in 90-degree increments using Swift. Check the API guide for more resources and examples.

```Swift
// Code example for temporarily rotating PDF page in 90-degree increments
```

--------------------------------

### Add Custom Free Text Input Accessory in iOS Keyboards with Swift

Source: https://www.nutrient.io/guides/ios/samples

Create a custom Free Text inputAccessory view for iOS keyboards using our Swift code example. Enhance user experience with tailored input controls for text annotations.

```swift
import PSPDFKit

// Implementing a custom accessory view often involves creating a custom UIView
// and assigning it to the inputAccessoryView property of a UITextView or similar.
// PSPDFKit provides mechanisms to hook into this process.
```

--------------------------------

### Disable Annotation Reviews in iOS Documents (Swift)

Source: https://www.nutrient.io/guides/ios/samples

Learn how to disable viewing and setting annotation reviews in iOS PDF documents. This guide offers resources and Swift code examples.

```swift
// Example code for disabling annotation reviews
// This snippet prevents users from accessing or setting review-related features for annotations.
// It's useful for specific workflow requirements.

// Placeholder for actual Swift code
print("Disabling annotation reviews...")
```

--------------------------------

### PDF Streaming with SwiftUI for On-Demand Document Loading

Source: https://www.nutrient.io/guides/ios/samples

Explore how to load document parts on demand in SwiftUI using this comprehensive example and source code. Perfect for enhancing your app's performance with PDF streaming.

```SwiftUI
// SwiftUI example for PDF streaming (on-demand loading).
// This is a placeholder and would contain actual implementation details.
console.log("PDF Streaming with SwiftUI.");
```

--------------------------------

### Java: Project Setup and Exception Handling

Source: https://www.nutrient.io/guides/java/editor/add-custom-page-to-pdf

Illustrates the basic Java project setup for using the Nutrient SDK, including specifying the package name, importing necessary classes, and defining the main function with potential `NutrientException` handling.

```java
package com.example.documentprocessing;

import com.nutrient.sdk.NutrientException;

public class DocumentProcessor {

    public static void main(String[] args) throws NutrientException {
        // Your document processing logic here
        // For example:
        // PdfEditor editor = new PdfEditor("input.docx");
        // editor.addPage(500, 800, 5);
        // editor.save("output.pdf");
    }
}
```

--------------------------------

### Initialize Helm Values File (Full)

Source: https://www.nutrient.io/guides/document-engine/deployment/helm

Copies the comprehensive 'values.yaml' file from the Document Engine Helm chart. This file contains all available configuration parameters for advanced customization.

```bash
helm show values document-engine/document-engine > values.yaml
```

--------------------------------

### Insert Page into PDF from Another Document in Swift

Source: https://www.nutrient.io/guides/ios/samples

Discover how to use PSPDFDocumentEditor to copy pages from other PDFs into your current document. This guide provides step-by-step instructions and source code examples in Swift.

```swift
let sourceDocument = PSPDFDocument(url: sourceURL)
let destinationDocument = PSPDFDocument(url: destinationURL)
destinationDocument.editor.insertPage(from: sourceDocument, page: 0, at: 0)
destinationDocument.save(to: destinationURL, for: .newDocument, completion: nil)
```

--------------------------------

### Initialize SearchViewController

Source: https://www.nutrient.io/guides/ios/migration-guides/pspdfkit-10-3-migration-guide

Demonstrates the correct initializer for SearchViewController, which is `init(document:)`, as other initializers have been marked as unavailable.

```swift
SearchViewController(document: pdfDocument)
```

--------------------------------

### Customize PDF View Margins in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to adjust document view margins in iOS to fit your custom UI. Explore our guide on PDF customization for more resources and examples on margin adjustments.

```swift
// Example code for customizing PDF view margins
```

--------------------------------

### Implement Flipbook (Page Curl) Effect Example

Source: https://www.nutrient.io/guides/web/release-notes/changelog

Provides a new Catalog Example demonstrating how to set up a flipbook or page curl effect, enhancing the user experience for document navigation.

```javascript
// Code for implementing a page curl effect.
```

--------------------------------

### Disable Annotation Reviews in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to disable viewing and setting annotation reviews in iOS documents. This guide offers resources and Swift code examples for managing annotation review functionality.

```swift
// Example code for disabling annotation reviews
```

--------------------------------

### Add Custom Free Text Input Accessory in iOS

Source: https://www.nutrient.io/guides/ios/samples

Learn how to create a custom Free Text inputAccessory view for iOS keyboards with a Swift code example to enhance user experience.

```swift
// Example code for custom Free Text input accessory in iOS
// This is a placeholder and would contain actual Swift code.
```

--------------------------------

### Create Custom Appearance Stream Generator in Swift

Source: https://www.nutrient.io/guides/ios/samples

Learn how to enhance vector stamp annotations with custom drawing. Explore the guide on appearance streams and access Swift code examples for implementation.

```swift
// Example of a custom appearance stream generator
// class CustomStampAppearanceStreamGenerator: PSPDFStampAppearanceStreamGenerator {
//     override func draw(in rect: CGRect, for annotation: PSPDFAnnotation) {
//         // Custom drawing code here
//         UIColor.red.setFill()
//         UIBezierPath(rect: rect).fill()
//     }
// }
```

--------------------------------

### Nutrient Catalog: Forms and Digital Signatures (Swift)

Source: https://www.nutrient.io/guides/ios/getting-started/example-projects

Shows examples of working with PDF forms and digital signatures using the Nutrient Catalog project.

```swift
// Example for Forms and digital signatures
// This could involve creating form fields or validating digital signatures.

/*
 // Creating a form field:
 let textField = PDFTextField(name: "username", rect: CGRect(x: 50, y: 50, width: 100, height: 20))
 // pdfPage.addAnnotation(textField)

 // Verifying a digital signature might involve:
 // let signatureVerificationResult = signatureAnnotation.verifySignature()
 */
```
Tokens:
Raw