PDFTron SDK .NET Core API

https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/
Admin
PDFTron SDK for .NET Core is a comprehensive PDF manipulation library that enables developers to...
Tokens:7,544
Snippets:76
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### GetName Method

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.SignatureHandler.html

Gets the name of this SignatureHandler. The name identifies the SignatureHandler and is added to the PDF as the value of the /Filter entry in the signature dictionary.

```APIDOC
## Method GetName()

Gets the name of this SignatureHandler. The name of the SignatureHandler is what identifies this SignatureHandler from all others. This name is also added to the PDF as the value of /Filter entry in the signature dictionary.

### Declaration
```csharp
public abstract string GetName()
```

### Returns
| Type   | Description              |
|--------|--------------------------|
| string | The name of this SignatureHandler. |
```

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

### PDFNet Initialization and Configuration

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

This section covers essential methods for initializing the PDFNet library, setting resource paths, and managing font substitutions.

```APIDOC
## PDFNet Class

### Description
The PDFNet class contains global library initialization, registration, configuration, and termination methods. There is only a single, static instance of the PDFNet class. Initialization and termination methods need to be called only once per application session.

### Methods

#### AddFontSubst(string fontname, string fontpath)

##### Description
Adds a font substitute by mapping a font name to a font file. This is useful for overriding default font selection when referenced fonts are not present.

##### Declaration
```csharp
public static bool AddFontSubst(string fontname, string fontpath)
```

##### Parameters
- **fontname** (string) - The name of the font to substitute.
- **fontpath** (string) - The path to the font file.

##### Returns
- **bool** - true if the substitution was successful.

#### AddFontSubst(PDFNet.CharacterOrdering ordering, string fontpath)

##### Description
Adds a font substitute for a specific character ordering, mapping it to a font file. This method is less specific and can override a range of missing fonts.

##### Declaration
```csharp
public static bool AddFontSubst(PDFNet.CharacterOrdering ordering, string fontpath)
```

##### Parameters
- **ordering** (PDFNet.CharacterOrdering) - The character ordering to map.
- **fontpath** (string) - The path to the font file.

##### Returns
- **bool** - true if the substitution was successful.

#### AddPDFTronCustomHandler(int custom_id)

##### Description
Registers a PDFTron Custom Security Handler. This is required to load documents encrypted with a custom security handler.

##### Declaration
```csharp
public static void AddPDFTronCustomHandler(int custom_id)
```

##### Parameters
- **custom_id** (int) - The user's custom ID, matching the one used during encryption.

##### Remarks
Calling this function is a requirement to load files encrypted with PDFTronCustomSecurityHandler.

#### AddResourceSearchPath(string val)

##### Description
Adds a search location for PDFNet resource files. PDFNet will look in these directories for necessary resource files.

##### Declaration
```csharp
public static void AddResourceSearchPath(string val)
```

##### Parameters
- **val** (string) - The resource directory path to add to the searched list.

### Examples
```csharp
// Initialize PDFNet
PDFNet.initialize();

// Set resource path
PDFNet.setResourcesPath("c:/myapp/resources");

// Specify font mappings
PDFNet.addFontSubst("MinionPro-Regular", "c:/myfonts/MinionPro-Regular.otf");
PDFNet.addFontSubst("Times-Roman", "c:/windows/fonts/times.ttf");

// Specify general font mappings for character orderings
PDFNet.addFontSubst(PDFNet.e_Identity, "c:/myfonts/arialuni.ttf"); // Arial Unicode MS
PDFNet.addFontSubst(PDFNet.e_Japan1, "c:/myfonts/KozMinProVI-Regular.otf");

// Add custom security handler
PDFNet.AddPDFTronCustomHandler(12345);

// Add resource search path
PDFNet.AddResourceSearchPath("c:/myapp/additional_resources");

// Load a PDF document (example)
// PDFDoc doc = new PDFDoc("c:/my.pdf");
```
```

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

### Initialize PDFNet and Add Font Substitutions

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

Initializes the PDFNet library, sets the resource path, and configures font substitutions for specific and general font mappings. This is crucial for ensuring correct font rendering in documents when original fonts are not available.

```csharp
PDFNet.initialize();
PDFNet.setResourcesPath("c:/myapp/resources");
// Specify specific font mappings...
PDFNet.addFontSubst("MinionPro-Regular", "c:/myfonts/MinionPro-Regular.otf");
PDFNet.addFontSubst("Times-Roman", "c:/windows/fonts/times.ttf");
PDFNet.addFontSubst("Times-Italic", "c:/windows/fonts/timesi.ttf");

// Specify more general font mappings...
PDFNet.addFontSubst(PDFNet.e_Identity, "c:/myfonts/arialuni.ttf");  // Arial Unicode MS
PDFNet.addFontSubst(PDFNet.e_Japan1, "c:/myfonts/KozMinProVI-Regular.otf");
PDFNet.addFontSubst(PDFNet.e_Japan2, "c:/myfonts/KozMinProVI-Regular.otf");
PDFNet.addFontSubst(PDFNet.e_Korea1, "c:/myfonts/AdobeSongStd-Light.otf");
PDFNet.addFontSubst(PDFNet.e_CNS1, "c:/myfonts/AdobeMingStd-Light.otf");
PDFNet.addFontSubst(PDFNet.e_GB1, "c:/myfonts/AdobeMyungjoStd-Medium.otf");
//...
PDFDoc doc = new PDFDoc("c:/my.pdf");
//...
```

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

### PDFNet Initialization

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

Functions for initializing the PDFNet library, with and without a license key.

```APIDOC
## Initialize()

### Description
Initializes PDFNet library. `Initialize()` is usually called once, during process initialization.

### Method
`public static void Initialize()`

### Remarks
With the exception of SetPersistentCache and SetTempPath, it is unsafe to call any other PDFNet API without first initializing the library.

## Initialize(string license_key)

### Description
Initializes PDFNet library. Initialize() is usually called once, during process initialization.

### Method
`public static void Initialize(string license_key)`

### Parameters
- **license_key** (string) - Required - license key used to activate the product. If the license_key is not specified, the product will work in demo mode. If the license_key is invalid, the function will throw an exception.

### Remarks
With the exception of SetPersistentCache, SetTempPath, and SetAPIDataOfflineProc, it is unsafe to call any other PDFNet API without first initializing the library.
```

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

### Terminate

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

A dummy method for SDK termination.

```APIDOC
## Terminate()

### Description
Dummy method for SDK termination.

### Method
`public static void Terminate()`
```

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

### Configuration Methods

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

This section details various methods for configuring the PDFTron SDK's behavior, such as setting default color profiles, disk caching, compression levels, and cache paths.

```APIDOC
## SetDefaultDeviceCMYKProfile(string)

### Description
Sets the default ICC color profile for DeviceCMYK color space.

### Method
public static void SetDefaultDeviceCMYKProfile(string icc_filename)

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

## SetDefaultDeviceRGBProfile(string)

### Description
Sets the default ICC color profile for DeviceRGB color space.

### Method
public static void SetDefaultDeviceRGBProfile(string icc_filename)

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

## SetDefaultDiskCachingEnabled(bool)

### Description
Sets the default policy on using temporary files.

### Method
public static void SetDefaultDiskCachingEnabled(bool use_disk)

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

## SetDefaultFlateCompressionLevel(int)

### Description
Sets the default policy on using temporary files.

### Method
public static void SetDefaultFlateCompressionLevel(int level)

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

## SetPersistentCachePath(string)

### Description
Set the location of persistent cache files.

### Method
public static void SetPersistentCachePath(string path)

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

## SetResourcesPath(string)

### Description
Sets the location of PDFNet resource file.

### Method
public static bool SetResourcesPath(string path)

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **bool** (bool) - true if path is found, false otherwise.

#### Response Example
None

## SetTempPath(string)

### Description
Set the location of temporary folder.

### Method
public static void SetTempPath(string path)

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

## SetViewerCache(uint, bool)

### Description
Sets the default parameters for the viewer cache. Any subsequently opened documents will use these parameters.

### Method
public static void SetViewerCache(uint max_cache_size, bool on_disk)

### Endpoint
N/A (Static method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### UndoManager Constructors

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.UndoManager.html

Provides information on how to instantiate the UndoManager class.

```APIDOC
## Constructors

### UndoManager(IntPtr)

#### Declaration
```csharp
public UndoManager(IntPtr impl_ptr)
```

#### Parameters
Type | Name | Description  
---|---|---
IntPtr | impl_ptr | 
```

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

### Configuration and Error Handling

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

Functions for setting up API data handling, color management, and connection error modes.

```APIDOC
## SetAPIDataOfflineProc(APIDataOfflineProc api_data_proc, object user_data)

### Description
Sets the API usage data handling delegate to report API usage offline.

### Method
`public static void SetAPIDataOfflineProc(PDFNet.APIDataOfflineProc api_data_proc, object user_data)`

### Parameters
- **api_data_proc** (PDFNet.APIDataOfflineProc) - Required - API usage data handling delegate.
- **user_data** (object) - Required - Custom data to be passed as the second parameter to 'api_data_proc'.

### Remarks
This function needs to be called before PDFNet.Initialize.

### Exceptions
- **PDFNetException** - PDFNetException the PDFNet exception

## SetColorManagement(CMSType cms)

### Description
Used to set a specific Color Management System (CMS) for use during color conversion operators, image rendering, etc.

### Method
`public static void SetColorManagement(PDFNet.CMSType cms)`

### Parameters
- **cms** (PDFNet.CMSType) - Required - identifies the type of color management to use.

### Exceptions
- **PDFNetException** - PDFNetException the PDFNet exception

## SetConnectionErrorHandlingMode(ConnectionErrorHandlingMode mode)

### Description
Sets the connection error handling behaviour for Apryse SDK. The default for this method is e_continue.

### Method
`public static void SetConnectionErrorHandlingMode(PDFNet.ConnectionErrorHandlingMode mode)`

### Parameters
- **mode** (PDFNet.ConnectionErrorHandlingMode) - Required - Rules that Apryse SDK will follow after a connection error.

### Exceptions
- **PDFNetException** - PDFNetException the PDFNet exception

## SetConnectionErrorProc(ConnectionErrorProc error_proc, object data)

### Description
Sets the error handling function to be called when an error is encountered when connecting to PDFTron Web Services.

### Method
`public static void SetConnectionErrorProc(PDFNet.ConnectionErrorProc error_proc, object data)`

### Parameters
- **error_proc** (PDFNet.ConnectionErrorProc) - Required - The error handling function.
- **data** (object) - Required - Custom data to be passed to the error handling function.
```

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

### Enable Local API Usage Logging

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

Call this method to enable writing API usage data to local JSON files. If set to false, no API usage is saved.

```csharp
public static void SetWriteAPIUsageLocally(bool write_usage)
```

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

### Terminate PDFTron SDK

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

Use this dummy method to terminate the PDFTron SDK. Ensure this is called when the SDK is no longer needed.

```csharp
public static void Terminate()
```

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

### Resource and Version Information

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

Functions to retrieve resource paths and version details of the PDFNet SDK.

```APIDOC
## GetResourcesPath()

### Description
Gets the location of PDFNet resources folder.

### Method
`public static string GetResourcesPath()`

### Returns
- **string** - the location of PDFNet resources folder. Empty string means that resources are located in your application folder.

## GetSystemFontList()

### Description
Get available fonts on the system.

### Method
`public static string GetSystemFontList()`

### Returns
- **string** - A JSON list of fonts accessible to PDFNet.

## GetVersion()

### Description
Gets the version.

### Method
`public static double GetVersion()`

### Returns
- **double** - PDFNet version number.

### Exceptions
- **PDFNetException** - PDFNetException the PDFNet exception

## GetVersionString()

### Description
Get PDFNet version as a string.

### Method
`public static string GetVersionString()`

### Returns
- **string** - PDFNet version as a string.
```

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

### SignatureHandler Class Overview

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.SignatureHandler.html

Provides details about the abstract SignatureHandler class, its namespace, assembly, and inheritance hierarchy.

```APIDOC
## Class SignatureHandler

A base class for SignatureHandler. SignatureHandler instances are responsible for defining the digest and cipher algorithms to sign and/or verify a PDF document. SignatureHandlers are added to PDF instances by calling the PDFDoc.AddSignatureHandler method.

### Inheritance
object
SignatureHandler

### Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()

###### Namespace : pdftron.SDF
###### Assembly : PDFTronDotNet.dll

##### Syntax
```csharp
public abstract class SignatureHandler
```
```

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

### SDK Cache Configuration

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

Configure the document cache settings for the SDK.

```APIDOC
## SDK Cache Configuration

### Description
Configures the document cache settings, including maximum size and storage location.

### Parameters
#### Query Parameters
- **max_cache_size** (uint) - Optional - The maximum size, in bytes, of the entire document's page cache. Set to zero to disable the viewer cache.
- **on_disk** (bool) - Optional - If set to 'true', cache will be stored on the local filesystem. If set to 'false', cache will be stored in heap memory.

### Remarks
Default on Desktop - max_cache_size: 512 MB, on_disk: true
Default on Mobile - max_cache_size: 100 MB, on_disk: false
```

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

### SignatureHandler Constructor

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.SignatureHandler.html

Details of the default constructor for the SignatureHandler class.

```APIDOC
## Constructor SignatureHandler()

### Declaration
```csharp
public SignatureHandler()
```
```

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

### CreateSignature Method

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.SignatureHandler.html

Calculates the actual signature using client-implemented signing methods. The returned value (byte array) will be written as the /Contents entry in the signature dictionary.

```APIDOC
## Method CreateSignature()

Calculates the actual signature using client implemented signing methods. The returned value (byte array) will be written as the /Contents entry in the signature dictionary.

### Declaration
```csharp
public abstract byte[] CreateSignature()
```

### Returns
| Type   | Description              |
|--------|--------------------------|
| byte[] | The calculated signature data. |
```

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

### UndoManager Methods

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.UndoManager.html

Details the various methods available in the UndoManager class for controlling undo and redo functionality.

```APIDOC
## Methods

### CanRedo()

Returns a boolean indicating whether it is possible to redo from the current snapshot.

#### Declaration
```csharp
public bool CanRedo()
```

#### Returns
Type | Description  
---|---
bool | A boolean indicating whether it is possible to redo from the current snapshot

### CanUndo()

Returns whether it is possible to undo from the current snapshot.

#### Declaration
```csharp
public bool CanUndo()
```

#### Returns
Type | Description  
---|---
bool | Whether it is possible to undo from the current snapshot

### Destroy()

#### Declaration
```csharp
public void Destroy()
```

### DiscardAllSnapshots()

Forget all changes in this manager (without changing the document).

#### Declaration
```csharp
public DocSnapshot DiscardAllSnapshots()
```

#### Returns
Type | Description  
---|---
DocSnapshot | An invalid DocSnapshot

### Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

#### Declaration
```csharp
public void Dispose()
```

### Dispose(bool)

#### Declaration
```csharp
protected virtual void Dispose(bool disposing)
```

#### Parameters
Type | Name | Description  
---|---|---
bool | disposing |   

### ~UndoManager()

#### Declaration
```csharp
protected ~UndoManager()
```

### GetNextRedoSnapshot()

Gets the next state of the document. This state may be invalid if it is impossible to redo.

#### Declaration
```csharp
public DocSnapshot GetNextRedoSnapshot()
```

#### Returns
Type | Description  
---|---
DocSnapshot | The next state of the document. This state may be invalid if it is impossible to redo

### GetNextUndoSnapshot()

Gets the previous state of the document. This state may be invalid if it is impossible to undo.

#### Declaration
```csharp
public DocSnapshot GetNextUndoSnapshot()
```

#### Returns
Type | Description  
---|---
DocSnapshot | The previous state of the document. This state may be invalid if it is impossible to undo

### Redo()

Restores to the next snapshot, if there is one.

#### Declaration
```csharp
public ResultSnapshot Redo()
```

#### Returns
Type | Description  
---|---
ResultSnapshot | A representation of the transition to the next snapshot, if there is one

### TakeSnapshot()

Creates a snapshot of document state, transitions to the new snapshot.

#### Declaration
```csharp
public ResultSnapshot TakeSnapshot()
```

#### Returns
Type | Description  
---|---
ResultSnapshot | A representation of the transition

### Undo()

Restores to the previous snapshot point, if there is one.

#### Declaration
```csharp
public ResultSnapshot Undo()
```

#### Returns
Type | Description  
---|---
ResultSnapshot | The resulting snapshot id
```

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

### Add Resource Search Path

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

Specifies an additional directory where PDFNet should look for resource files. This can be used to provide custom resources or override default ones.

```csharp
PDFNet.AddResourceSearchPath(val);
```

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

### AppendData Method

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.SignatureHandler.html

Adds data to be signed. This data is the raw serialized byte buffer as the PDF is being saved to any stream.

```APIDOC
## Method AppendData(byte[])

Adds data to be signed. This data will be the raw serialized byte buffer as the PDF is being saved to any stream.

### Declaration
```csharp
public abstract void AppendData(byte[] data)
```

### Parameters
| Type   | Name | Description              |
|--------|------|--------------------------|
| byte[] | data | A chunk of data to be signed. |
```

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

### Iterate through SDF Dictionary Entries

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.html

Use DictIterator to traverse key-value pairs in a dictionary. Ensure to check hasCurrent() before accessing key, value, and calling next().

```csharp
DictIterator itr = dict.getDictIterator();
   while (itr.hasCurrent()) {
   Obj key = itr.key();		
   printf(key.getName());
   Obj value = itr.value();
   //...
   itr.next()
   }
   }
```

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

### Obj Class

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.html

Obj is a concrete class for all SDF/Cos objects, implementing the composite design pattern. It allows invoking member functions through the Obj interface and provides type-checking methods.

```APIDOC
## Obj Class

### Description
Obj is a concrete class for all SDF/Cos objects. It implements the composite design pattern, allowing member functions of derived objects to be invoked through the Obj interface. Type information can be obtained using `GetType()` or `Is???()` methods. Objects cannot be shared across documents but can be copied using `Doc.ImportObj()`. Objects can be shared within a document if created as indirect objects using `Doc.CreateIndirect???()` methods.

### Methods
- `GetType()`: Returns the type of the Obj.
- `Is???()`: Methods to check the specific type of the Obj (e.g., `IsNumber()`, `IsString()`).
- `Doc.ImportObj(Obj)`: Copies an object from one document to another.
- `Doc.CreateIndirect???()`: Creates an indirect object of a specified type.
```

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

### NameTree Class

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.html

A NameTree is a common data structure in PDF used for associating keys (strings) with values (Obj*). It allows for efficient storage of large collections of associations and supports SDF/Cos-style strings.

```APIDOC
## NameTree Class

### Description
A NameTree is a common data structure in PDF, similar to a dictionary but optimized for large collections of string keys and Obj values. It allows for efficient storage and retrieval of associations, supporting SDF/Cos-style strings which may include Unicode encoding.

### Reference
See section 3.8.5 'Name Trees' in PDF Reference Manual for more details.
```

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

### JavaScript Engine Management

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

Functions to enable, disable, and check the status of the JavaScript engine.

```APIDOC
## EnableJavaScript(bool enable)

### Description
A switch that can be used to turn on/off JavaScript engine.

### Method
`public static void EnableJavaScript(bool enable)`

### Parameters
- **enable** (bool) - Required - true to enable JavaScript engine, false to disable.

## IsJavaScriptEnabled()

### Description
Test whether JavaScript is enabled.

### Method
`public static bool IsJavaScriptEnabled()`

### Returns
- **bool** - true, if it is enabled, false otherwise.
```

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

### SDFDoc.SaveOptions Enum

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.html

Enum representing options for saving an SDFDoc.

```APIDOC
## SDFDoc.SaveOptions Enum

### Description
This enum defines various options that can be used when saving an SDFDoc.

### Enum Values
- `e_linearized`
- `e_no_incremental_save`
- `e_remove_unused`
- `e_hex_strings`
- `e_compress_filter`
- `e_no_cross_ref_table`
```

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

### SDFDoc Class

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.html

SDFDoc represents a low-level document structure composed of SDF.Obj nodes, enabling the creation of higher-level document models like PDF and FDF. It integrates document security, utility methods, and all SDF objects.

```APIDOC
## SDFDoc Class

### Description
SDFDoc is a low-level document representing a graph of SDF.Obj nodes. It can be used to build higher-level document models such as PDF (Portable Document Format) or FDF (Forms Document Format). SDFDoc integrates document security, document utility methods, and all SDF objects.

### Features
- Manages document security.
- Provides document utility methods.
- Contains all SDF objects.
```

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

### UndoManager Class Overview

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.UndoManager.html

The UndoManager class allows for the management of undo and redo operations on a document. It is mapped one-to-one with the document it manages and implements the IDisposable interface.

```APIDOC
## Class UndoManager

Undo-redo interface; one-to-one mapped to document.

### Inheritance
object
UndoManager

### Implements
IDisposable

### Namespace
pdftron.SDF

### Assembly
PDFTronDotNet.dll

### Syntax
```csharp
public class UndoManager : IDisposable
```
```

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

### Add PDFTron Custom Security Handler

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

Registers a custom security handler with PDFNet. This is a prerequisite for loading documents that were encrypted using a corresponding PDFTronCustomSecurityHandler.

```csharp
PDFNet.AddPDFTronCustomHandler(custom_id);
```

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

### Reset Method

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.SignatureHandler.html

Resets any data appending and signature calculations done so far, allowing PDFNet to restart the signature calculation process. Any data processed with AppendData should be discarded.

```APIDOC
## Method Reset()

Resets any data appending and signature calculations done so far. This method should allow PDFNet to restart the whole signature calculation process. It is important that when this method is invoked, any data processed with the AppendData method should be discarded.

### Declaration
```csharp
public abstract bool Reset()
```

### Returns
| Type   | Description              |
|--------|--------------------------|
| bool   | True if there are no errors, otherwise false. |
```

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

### DictIterator Class

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.html

DictIterator is used to traverse key-value pairs in a dictionary. It allows iteration through all entries in a given Obj dictionary.

```APIDOC
## DictIterator Class

### Description
DictIterator is used to traverse key-value pairs in a dictionary. It can be used to print out all the entries in a given Obj dictionary.

### Usage Example
```csharp
DictIterator itr = dict.getDictIterator();
while (itr.hasCurrent()) {
    Obj key = itr.key();
    // Process key
    Obj value = itr.value();
    // Process value
    itr.next();
}
```
```

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

### SetWriteAPIUsageLocally

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.PDFNet.html

Enable or disable local writing of API usage data.

```APIDOC
## SetWriteAPIUsageLocally(bool)

### Description
Enable writing API usage locally. If the parameter is true, API usage will be written to local JSON files in the persistent cache path; otherwise, no API usage is saved.

### Method
`public static void SetWriteAPIUsageLocally(bool write_usage)`

### Parameters
#### Path Parameters
- **write_usage** (bool) - Required - If parameter is true API usage will be written to local JSON files in the persistent cache path otherwise no API usage is saved.

### Exceptions
- **PDFNetException** - PDFNetException the PDFNet exception
```

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

### Obj.ObjType Enum

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.html

Enum representing the different types of SDF/Cos objects.

```APIDOC
## Obj.ObjType Enum

### Description
This enum defines the possible types for SDF/Cos objects.

### Enum Values
- `e_null`
- `e_boolean`
- `e_number`
- `e_string`
- `e_name`
- `e_array`
- `e_dict`
- `e_stream`
- `e_octets`
```

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

### SignatureHandlerId Struct

Source: https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/api/pdftron.SDF.SignatureHandlerId.html

The SignatureHandlerId struct is used for identifying SignatureHandler instances as they are added to the PDFDoc's SignatureManager. It provides implicit conversion operators to and from UIntPtr.

```APIDOC
## Struct SignatureHandlerId

Used for identifying a SignatureHandler instances as they are added to the PDFDoc's SignatureManager.

### Namespace
pdftron.SDF

### Assembly
PDFTronDotNet.dll

### Syntax
```csharp
public struct SignatureHandlerId
```

### Operators
#### implicit operator SignatureHandlerId(UIntPtr)

Converts a UIntPtr to a SignatureHandlerId.

##### Declaration
```csharp
public static implicit operator SignatureHandlerId(UIntPtr value)
```

##### Parameters
- **value** (UIntPtr) - The UIntPtr value to convert.

##### Returns
- SignatureHandlerId - The resulting SignatureHandlerId.

#### implicit operator UIntPtr(SignatureHandlerId)

Converts a SignatureHandlerId to a UIntPtr.

##### Declaration
```csharp
public static implicit operator UIntPtr(SignatureHandlerId handler)
```

##### Parameters
- **handler** (SignatureHandlerId) - The SignatureHandlerId to convert.

##### Returns
- UIntPtr - The resulting UIntPtr value.
```
Tokens:
Raw