This repository contains samples and utilities for Document Filters, a set of tools for converting and processing various document formats. Explore the following directories and files to understand and use the capabilities of Document Filters.
The Document Filters Sample GitHub Repository includes:
- Samples for converting documents to different formats such as PDF, PNG, SVG, and more.
- Utilities for common tasks like extracting words from documents.
- A shared common library for Document Filters samples.
- Visual Studio solution file and the license information.
Explore the contents to leverage the power of Document Filters in your document processing projects.
To get started on your own project, check out the Getting Started section in the documentation.
| Name | Description |
|---|---|
| CombineDocuments | Combines multiple documents into a single multi-page document, with the ability to create an optional thumbnail page. |
| ConvertDocument | Converts documents to either text or flow-html. Additionally, sub-files can also be processed. |
| ConvertDocumentToHDHTML | Converts documents to high-definition, paginated HTML. |
| ConvertDocumentToPDF | Converts documents to PDF format. |
| ConvertDocumentToPNG | Converts documents to PNG format. |
| ConvertDocumentToPostscript | Converts documents to Postscript format. |
| ConvertDocumentToStructuredXML | Converts documents to structured XML. |
| ConvertDocumentToSVG | Converts documents to SVG format. |
| ConvertDocumentToThumbnail | Converts documents to thumbnail images. |
| ConvertDocumentToTIFF | Converts documents to TIFF format. |
| ConvertDocumentToTIFFFromMemory | Converts documents to TIFF format from memory. |
| ConvertDocumentToTIFFStream | Converts documents to TIFF format using streams. |
| ConvertDocumentWithComments | Converts documents to a multi-page PDF, with comments shown in either the margin or on new pages. |
| CreateBarcode | Demonstrates create 1D and 2D bar codes |
| ExtractAnnotations | Extracts annotations from documents. |
| ExtractForms | Extracts forms from documents. |
| ExtractSubfiles | Extracts subfiles from documents or archive, with support for password protected files. |
| GetDocumentWords | Retrieves words from documents. |
| LocalizeMetadata | Localizes metadata within documents, mapping rendered metadata to either English, French, German or Korean. |
| MarkupAnnotationsDemo | Demonstrates marking up annotations in documents. |
| RedactionDemo | Demonstrates redacting content in a document based on various different rule type. |
| UpdateForm | Updates form data within a PDF document. |
| DfSamplesCommon | Common functionality for Document Filters samples. |
| DocumentFiltersLicense.cs | Update with your Document Filters License Key |
You can run the sample applications without a license key, with some limitations. See Document Filters Evaluation for details.
To run the sample applications without feature limitations, ensure you have a valid Document Filters
license key. You can provide this key by either modifying the
DocumentFiltersLicense.cs file or setting it in an environment variable named
DF_LICENSE_KEY.
The .NET projects are compatible with win-x64, win-x64, linux-x64, linux-musl-x64, osx-x64, and osx-arm64.
The samples are configured to pull Document Filters from NuGet. This is
configured in the DfSamplesCommon projects.
To compile all samples from the command line, execute:
cd samples/csharp
dotnet build Each sample is compiled into its own directory, with binaries generated in
${PROJECT}/bin/${CONFIGURATION}/net6.0.
To build all the samples and copy them to a single directory, run:
dotnet publish -o binAlternatively, you can open the sln in Visual Studio or the folder in VS Code.