Documentation – Overview

Net: Supported File Formats

Sat, 05 Jun 2021 00:00:00 +0000

The following table indicates the file formats that Aspose.PDF C# can load and Save.

Format	Description	Load	Save	Remarks
PDF	Portable Document Format
CGM	Computer Graphics Metafile for 2D vector graphics
EPUB	Ebook file format
HTML	HTML Format
TeX	LaTex typesetting file format
MHT	MHTML Document
PCL	Printer Control Language Files
PS	Postscript Files
SVG	Scalable Vector Graphics (An XML-based vector image format)
XML	XML Format
XPS	XPS Documents
XSLFO	XSL-FO is part of XSL file which is used for the transformation and formatting of XML data
MD	Markdown Format
XLS	Saves the document in the Microsoft Excel SpreadSheet
XLSX	Saves the document in the Microsoft Excel 2007 format
PPTX	Saves the document in the Microsoft PowerPoint Presentations format
DOC	Saves the document in the Microsoft Word format
DOCX	Saves the document in the Microsoft Word format
MobiXML	Saves the document in eBook MobiXML Standard format
JPEG	Saves the document in JPEG Format
EMF	Enhanced metafile format (EMF)
PNG	Saves the document in PNG Format
BMP	Saves the document in BMP Format
GIF	Graphic Interchange Format
TIFF	Saves the document as Single or Multi-Page TIFF Image
Text	Save the document int Text Format

Net: Key Features of Aspose.PDF

Sat, 05 Jun 2021 00:00:00 +0000

General Features

Written completely in C#, works with .NET Framework.
.NET environment required.
Supports Windows Forms and ASP.NET applications.
API reference in HTML and Microsoft Help format.
Supported .NET Frameworks (2.0, 3.5, 4.0, 4.0_ClientProfile, 4.5.0, 4.5.1, 4.6.0, 4.6.2, 4.7, 4.7.2).
.NET Standard 2.0 (.NET Core 2.0/2.1)
32-bit OS
64-bit OS

Supported PDF versions

Aspose.PDF for .NET supports PDF versions 1.2, 1.3, 1.4, 1.5, 1.6 and 1.7.

Fonts

14 core fonts.
Type 1 fonts.
TrueType fonts.
Type 3 fonts.
CJK fonts.
Unicode support.

Text

Extract text from pages.
Search text from pages.
Get text segments.
Search text using regular expressions.
Replace text.
Replace text using regular expressions.
Replace first or particular occurrence of a phrase.
Add text in PDF file.

Images

Add image in PDF file.
Delete images.
Replace images.
Extract images.
PDF to JPEG conversion (particular page or all pages).
PDF to TIFF conversion (individual pages or a single TIFF image).
PDF to PNG conversion (particular page or all pages).
PDF to BMP conversion.

Attachments

Add attachment.
Get attachments.
Delete attachments.
Get attachment information.

Document

Get document viewer properties.
Set document viewer properties.
Get page display properties.
Set page display properties.
Get PDF file information.
Set PDF file information.
Linearization (optimization for the web).
Validation (PDF/A-1a, PDF/A-1b, PDF/A-2a).
Set XMP metadata.
Get XMP metadata.
PDF to DOC/DOCX conversion.
PDF to HTML conversion.
PDF to XPS conversion.
PDF to Tex conversion.

Bookmarks

Add bookmarks.
Add child bookmarks.
Delete bookmarks.
Get bookmarks.
Get child bookmarks.
Modify bookmarks.
Modify child bookmarks.

Annotations

Add annotations.
Get annotations.
Delete annotations.
Modify annotations.

Forms

Add fields.
Delete fields.
Modify fields.
Fill fields.
Get field values.
Support for XFA (XML based Forms) and AcroForms (Standard Forms)

Operators

Add operators in PDF file.

Stamp and Watermark

Add text stamp.
Add image stamp.
Add PDF page stamp.
Add page number stamp.
Add text in the header.
Add image in the header.
Add text in the footer.
Add image in the footer.

Links and Actions

Create application link.
Create JavaScript link.
Remove document open action.
Extract links.

Security and Signatures

Encrypt PDF.
Decrypt PDF.
Modify password.

Miscellaneous

Get build version information.

Net: System Requirements

Fri, 12 May 2023 00:00:00 +0000

Overview

To produce and manipulate PDF documents, the machine that Aspose.PDF for .NET runs on doesn’t need to have Adobe Acrobat installed: Aspose.PDF for .NET is a PDF document creation engine. To view PDF documents produced by Aspose.PDF for .NET, however, the machine does need at least an Adobe Acrobat Reader. It can be downloaded for free.

Supported Operating System

Windows

Microsoft Windows 2003 Server (x64, x86)
Microsoft Windows 2008 Server (x64, x86)
Microsoft Windows 2012 Server (x64, x86)
Microsoft Windows 2012 R2 Server (x64, x86)
Microsoft Windows 2016 Server (x64, x86)
Microsoft Windows 2019 Server (x64, x86)
Microsoft Windows Vista (x64, x86)
Microsoft Windows XP (x64, x86)
Microsoft Windows 7 (x64, x86)
Microsoft Windows 8, 8.1 (x64, x86)
Microsoft Windows 10 (x64, x86)
Microsoft Windows 11 (x64, x86)
Microsoft Azure

macOS

Mac OS X x64 (10.12+)

Linux

Linux x64 ( 6, 7 ,27, 9, 8.7+, 18.04, 16.04, 14.04, 18, 17, 42.3+, 12 SP2+)

Development Environments

You can use Aspose.PDF for .NET to develop applications in any development environment that targets the .NET platform, but the following environments are explicitly supported:

Microsoft Visual Studio 2010
Microsoft Visual Studio 2011
Microsoft Visual Studio 2012
Microsoft Visual Studio 2013
Microsoft Visual Studio 2015
Microsoft Visual Studio 2017
Microsoft Visual Studio 2019
Microsoft Visual Studio 2022

Supported Frameworks

The following .NET Framework versions are supported:

.NET Framework 4.0
.NET Framework 4.5.0
.NET Framework 4.5.1
.NET Framework 4.5.2
.NET Framework 4.6.0
.NET Framework 4.6.2
.NET Framework 4.5.0
.NET Framework 4.5.1
.NET Framework 4.6.0
.NET Framework 4.6.2
.NET Framework 4.7
.NET Framework 4.7.2
.NET Framework 4.8.1
.NET Standard 2.0 (.NET Core 3.1+)
.NET 6.0
.NET 7.0

Net: How to Install Aspose.PDF for .NET

Sat, 05 Jun 2021 00:00:00 +0000

Aspose.PDF C# component

Aspose.PDF is a .NET component built to allow developers to create PDF documents, whether simple or complex, on the fly programmatically. Aspose.PDF for .NET allows developers to insert tables, graphs, images, hyperlinks, custom fonts - and more - into PDF documents. Moreover, it is also possible to compress PDF documents. Aspose.PDF for .NET provides excellent security features to develop secure PDF documents. And the most distinct feature of Aspose.PDF for .NET is that it supports the creation of PDF documents through both an API and from XML templates.

Product Description

Aspose.PDF for .NET is a robust .NET component that lets developers create PDF documents from scratch without using Adobe Acrobat. It provides a simple Application Programming Interface (API) that is easy to learn and use.

Aspose.PDF for .NET is implemented using Managed C# and it can be used with any .NET language like C#, VB.NET and J# etc. It can be integrated with any kind of application either it’s an ASP.NET Web Application or a Windows Application.

So that the developers can get up and running quickly, Aspose.PDF for .NET provides fully featured demos and working examples written in C#. Using these demos, developers can quickly learn about the features provided by Aspose.PDF for .NET.

The fast, light-weight component creates PDF documents efficiently and helps your application perform better. Aspose.PDF for .NET is our customers’ first choice when creating PDF documents because of its price, superb performance and great support.

Aspose.PDF for .NET is multithread safe as long as only one thread works on a document at a time. It is a typical scenario to have one thread working on one document. Different threads can safely work on different documents at the same time.

Declaration

All Aspose .NET components require Full Trust permission set. The reason is, Aspose .NET components need to access registry settings, system files other than virtual directory for certain operations like parsing fonts etc. Moreover, Aspose .NET Components are based on core .NET system classes that also require Full Trust permission set in many cases.

Internet Service Providers hosting multiple applications from different companies mostly enforce Medium Trust security level. In case of .NET 2.0, such security level applies the following constraints:

OleDbPermission is not available. This means you cannot use the ADO.NET managed OLE DB data provider to access databases.
EventLogPermission is not available. This means you cannot access the Windows event log.
ReflectionPermission is not available. This means you cannot use reflection.
RegistryPermission is not available. This means you cannot access the registry.
WebPermission is restricted. This means your application can only communicate with an address or range of addresses that you define in the <trust> element.
FileIOPermission is restricted. This means you can only access files in your application’s virtual directory hierarchy. Due to the reasons specified above, Aspose .NET components cannot be used on servers granting permission set other than Full Trust.

Installation

Evaluate Aspose.PDF for .NET

You can easily download Aspose.PDF for .Net for evaluation. The evaluation download is the same as the purchased download. The evaluation version simply becomes licensed when you add a few lines of code to apply the license.

The evaluation version of Aspose.PDF (without a license specified) provides full product functionality, but it has two limitations: it inserts an evaluation watermark, and only four elements of any collection can be viewed/edited.

If you want to test Aspose.PDF for .NET without the evaluation version limitations, you can also request a 30-day Temporary License. Please refer to How to get a Temporary License?

Installing Aspose.PDF for .NET through NuGet

NuGet is a free, open source developer-focused package management system for the .NET platform intent on simplifying the process of incorporating third party libraries into a .NET application during development. It is a Visual Studio extension that makes it easy to add, remove, and update libraries and tools in Visual Studio projects that use the .NET Framework. A library or tool can easily be shared with other developers by creating a NuGet package and storing it inside a NuGet repository. When you install the package, NuGet copies files to your solution and automatically makes the necessary changes, such as adding references and changing your app.config or web.config files. If you decide to remove the library, NuGet removes files and reverses whatever changes it made to your project so that no clutter is left.

Referencing Aspose.PDF for .NET

Install package using the Package Manager Console

Open your .NET application in Visual Studio.
On the Tools menu, select NuGet Package Manager and then Package Manager Console.
Type the command Install-Package Aspose.PDF to install the latest full release, or type the command Install-Package Aspose.PDF -prerelease to install the latest release including hot fixes.
Press Enter

Update package using the Package Manager Console

If you have already referenced the component through NuGet, follow these steps to update the reference to the latest version:

Open you .NET application in Visual Studio.
On the Tools menu, select NuGet Package Manager and then Package Manager Console.
Type the command Update-Package Aspose.PDF to reference the latest full release, or type the command Update-Package Aspose.PDF -prerelease to install latest release including hot fixes.

Install Package using the Package Manager GUI

Follow these steps to reference the component using the package manager GUI:

Open you .NET application in Visual Studio.
From the Project menu select Manage NuGet Packages.
Select Broswe tab.
Type Aspose.PDF into the search box to find Aspose.PDF for .NET.
Click Install/Update next to the latest version of Aspose.PDF for .NET.

Working with .NET Core DLLs in Non-Windows Environment

As Aspose.PDF for .NET provides .NET Standard 2.0 (.NET Core 2.0) support, so it can be used in Core Applications running in Linux like operating systems. We are constantly working over improving the .NET Core support in our API. However, there are some following operations which we recommend our customers to perform, in order to get better results while using features of Aspose.PDF for .NET:

Please install:

libgdiplus package
package with Microsoft compatible fonts: ttf-mscorefonts-installer. (e.g. sudo apt-get install ttf-mscorefonts-installer) These fonts should be placed in “/usr/share/fonts/truetype/msttcorefonts” directory as Aspose.PDF for .NET scans this folder on Linux like operating systems. In case operating system has other default folder/directory for fonts, you should use following line of code before performing any operation using Aspose.PDF.

Aspose.Pdf.Text.FontRepository.Sources.Add(new FolderFontSource("<user's path to ms fonts>"));

Net: Aspose PDF License

Sat, 05 Jun 2021 00:00:00 +0000

Limitation of an evaluation version

We want our customers to test our components thoroughly before buying so the evaluation version allows you to use it as you would normally.

PDF created with an evaluation watermark. The evaluation version of Aspose.PDF for .NET provides full product functionality, but all the pages in the generated PDF documents are watermarked with “Evaluation Only. Created with Aspose.PDF. Copyright 2002-2020 Aspose Pty Ltd” at the top.
The limit of the number of collection items that can be processed. In the evaluation version from any collection, you can process only four elements (for example, only 4 pages, 4 form fields, etc.).

If you want to test Aspose.HTML for .NET without the evaluation version limitations, you can also request a 30-day Temporary License. Please refer to How to get a Temporary License?

Classic license

The license can be loaded from a file or stream object. The easiest way to set a license is to put the license file in the same folder as the Aspose.PDF.dll file and specify the file name without a path, as shown in the example below.

If you use any other Aspose for .NET component along with Aspose.PDF for .NET, please specify the namespace for License like Aspose.Pdf.License.

Loading a license from file

The easiest way to apply a license is to put the license file in the same folder as the Aspose.PDF.dll file and specify just the file name without a path.

When you call the SetLicense method, the license name that you pass should be that of your license file. For example, if you change the license file name to “Aspose.PDF.lic.xml” pass that file name to the Pdf.SetLicense(…) method.


public static void SetLicenseExample()
{
    // Initialize license object
    Aspose.Pdf.License license = new Aspose.Pdf.License();
    try
    {
        // Set license
        license.SetLicense("Aspose.Pdf.lic");
    }
    catch (Exception)
    {
        // something went wrong
        throw;
    }
    Console.WriteLine("License set successfully.");
}

Loading the license from a stream object

The following example shows how to load a license from a stream.

public static void SetLicenseFromStream()
{
    // Initialize license object
    Aspose.Pdf.License license = new Aspose.Pdf.License();
    // Load license from the file stream
    System.IO.FileStream myStream =
        new System.IO.FileStream(
            "Aspose.Pdf.lic",
            System.IO.FileMode.Open);
    // Set license
    license.SetLicense(myStream);
    Console.WriteLine("License set successfully.");
}

Metered License

Aspose.PDF allows developers to apply metered key. It is a new licensing mechanism. The new licensing mechanism will be used along with existing licensing method. Those customers who want to be billed based on the usage of the API features can use the metered licensing. For more details, please refer to Metered Licensing FAQ section.

A new class Metered has been introduced to apply metered key. Following is the sample code demonstrating how to set metered public and private keys.

For more details, please refer to the Metered Licensing FAQ section.

public static void SetMeteredLicense()
{
    // set metered public and private keys
    Aspose.Pdf.Metered metered = new Aspose.Pdf.Metered();
    // Access the setMeteredKey property and pass public and private keys as parameters
    metered.SetMeteredKey(
        "<type public key here>",
        "<type private key here>");

    // Load the document from disk.
    Document doc = new Document("input.pdf");
    //Get the page count of document
    Console.WriteLine(doc.Pages.Count);
}

Please note that COM applications that work with Aspose.PDF for .NET should also use the License class.

One point which needs consideration: Please note that the embedded resources are included in assembly the way they are added i.e. if you add text file as an embedded resource in the application and open the resultant EXE in notepad, you will see the exact contents of text file. So when using license file as an embedded resource, anyone can open exe file in some simple text editor and see/extract the contents of embedded license.

Therefore, in order to put an extra layer of security when embedding the license with the application, you can compress/encrypt license and after that, you can embed it into the assembly. Suppose we have Aspose.PDF.lic license file, so let’s make Aspose.PDF.zip with password test and embed this zip file into solution. The following code snippet can be used to initialize the license:

using System;
using System.IO;
using System.IO.Compression;
using System.Reflection;

namespace Aspose.Pdf.Examples
{
    class ExampleLicensing
    {
        public static void LicenseDemo()
        {
            License license = new License();
            license.SetLicense(GetSecureLicenseFromStream());
            Document doc = new Document("document.pdf");
            //Get the page count of document
            Console.WriteLine(doc.Pages.Count);
        }

        private static Stream GetSecureLicenseFromStream()
        {
            var assembly = Assembly.GetExecutingAssembly();
            var memoryStream = new MemoryStream();
            using (var zipToOpen = assembly.GetManifestResourceStream("Aspose.Pdf.Examples.License.Aspose.PDF.zip"))
            {
                using (ZipArchive archive = new ZipArchive(zipToOpen ?? throw new InvalidOperationException(), ZipArchiveMode.Read))
                {
                    var unpackedLicense  = archive.GetEntry("Aspose.PDF.lic");
                    unpackedLicense?.Open().CopyTo(memoryStream);
                }
            }

            memoryStream.Position = 0;
            return memoryStream;
        }
    }
}

Applying a License Bought Before 2005/01/22

Aspose.PDF for .NET no longer supports the old-style licenses. If you have a license from before 22 January 2005 and you have updated to a more recent version of Aspose.PDF, please contact our Sales team to get a new license file.

Net: Aspose.PDF for .NET Support

Sat, 05 Jun 2021 00:00:00 +0000

Aspose.PDF allows you to use free technical support for all its products. If you have questions about Aspose.PDF, check the next article:

The most popular source of support is Aspose.Forums. In the Aspose.PDF forum section, you can ask your question and get an answer as soon as possible.
You should know, that Aspose does not provide technical support over the phone. You can call is only available for sales and purchase questions.
Please remember, that we have time zone differences, this may affect the speed of responses to you.

If you need help with an issue with Aspose.PDF, follow the next reccomendations to make sure it is resolved in the most efficient way:

Firstly, check that you use the latest Aspose.PDF version before reporting the issue, see Aspose.PDF for .NET Downloads to find out about the latest version.
Perhaps the solution to your problem has already been discussed and has a solution, for this, study the forum and documentation, check API Reference before reporting the issue.
When you form your question, please include the original document and possibly a fragment of your code that causes the problem. You can zip these files into one document if there are several.
Don’t worry, only you and the developers of Aspose have access to the sticky files.