Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions getting-started/Installation/install-nuget-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ position: 7

# Install using NuGet Packages

This article describes how you can install the Document Processing Libraries using a NuGet package. There are two ways for getting the NuGet packages:
This article describes how you can install the Document Processing Libraries using a NuGet package.
You can find all Document Processing Libraries packages in the [Available NuGet Packages]({%slug available-nuget-packages%}) article. There are two ways for getting the NuGet packages:

* [Manually download the packages](#manually-download-nuget-packages)

Expand Down Expand Up @@ -39,14 +40,6 @@ This approach allows you to setup a local NuGet package source, so you can insta

![install-using-nuget003](images/install-using-nuget003.png)

>important The Telerik Document Processing libraries are available in two versions:
>
>* A version for __.Net Framework 4.6.2__ or later
>
>* A version for __.Net Standard 2.0__
>
>Both versions are available as NuGet packages but with different names. The packages for __.NET Standard__ do __not__ contain the word __Windows__ in their name.

## Download from the NuGet server

To install the Telerik Document Processing Libraries, you can use the NuGet packages hosted on the public Telerik NuGet server. This online source lets you download and install various versions of the Document Processing libraries and enables quick updates with minimal manual intervention.
Expand Down
376 changes: 300 additions & 76 deletions getting-started/Installation/nuget-packages.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion getting-started/first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ This sample application will use [RadWordsProcessing]({%slug radwordsprocessing-
For .NET Standard ({{site.dotnetversions}}) project:
* __Telerik.Documents.Flow.FormatProviders.Pdf__

> The Document Processing packages for {{site.dotnetversions}} don't contain "Windows" in their names.
You can find all Document Processing Libraries packages in the [Available NuGet Packages]({%slug available-nuget-packages%}) article.

## Step 4: Create a Document

Expand Down
50 changes: 1 addition & 49 deletions getting-started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,55 +15,7 @@ position: 0

>important Please install **<PackageReference Include="Telerik.Licensing" Version="1.*" />**.

The following tables list all Telerik Document Processing packages for the different platforms and their roles:

>important The .NET Standard packages are compatible with any .NET version (e.g .NET 9), even if there are no packages explicitly available for the specific versions. The same applies to the .NET Framework packages.

### Packages for .NET Standard (Support for {{site.dotnetversions}})

| Packagea Name| Description |
|-------|----------------|
| **Telerik.Documents.Core** | The main package from the Telerik document processing libraries. You always need it when you intend to use the library. |
| **Telerik.Documents.Flow** | Part of the words (text) processing library. It is needed for processing HTML, DOCX, RTF and TXT documents. |
| **Telerik.Documents.DrawingML** | Part of the words (text) processing library. It is needed for working with shapes inside the documents. |
| **Telerik.Documents.Flow.FormatProviders.Doc** | Allows importing of DOC and DOT document. |
| **Telerik.Documents.Flow.FormatProviders.Pdf** | Allows exporting of flow documents (DOCX, DOC, DOT, RTF, and HTML) to PDF. |
| **Telerik.Documents.Fixed** | Part of the PDF processing library. It is needed for working with PDF documents. |
| **Telerik.Documents.Fixed.FormatProviders.Ocr** | This package is needed for the [Optical Character Recognition (OCR)]({%slug radpdfprocessing-formats-and-conversion-ocr-ocrformatprovider%}) functionality. |
| **Telerik.Documents.Tesseract.Ocr** | This package is needed for the [Optical Character Recognition (OCR)]({%slug radpdfprocessing-formats-and-conversion-ocr-ocrformatprovider%}) functionality. |
| **Telerik.Documents.ImageUtils** | This package is required when exporting to `PDF` format a document containing images different than Jpeg and Jpeg2000 or ImageQuality different than High. For more information check the [PdfProcessing`s Cross-Platform Support]({%slug radpdfprocessing-cross-platform%}) article.
| **Telerik.Documents.CMapUtils** | Provides a default implementation for getting the data of a predefined CMap table by a given name. The package is optional and you will need to include a reference to it only if you need to process documents with [CMap tables]({%slug radpdfprocessing-concepts-cmap-tables%}). |
| **Telerik.Documents.Spreadsheet** | The main package for the spreadsheet processing. It is needed for processing XLSX, CSV, TXT documents. |
| **Telerik.Documents.Spreadsheet.FormatProviders.OpenXml** | This package is needed for processing XLSX documents. |
| **Telerik.Documents.Spreadsheet.FormatProviders.Pdf** | This package is needed for exporting to PDF documents. |
| **Telerik.Documents.Spreadsheet.FormatProviders.Xls** | This package is needed for processing XLS documents. |
| **Telerik.Documents.SpreadsheetStreaming** | The main package for generating huge spreadsheet files using minimum resources. |
| **Telerik.Zip** |It is the main package of the [Telerik Zip Library]({%slug radziplibrary-overview%}). |


### Assemblies for .NET Framework

| package Name| Description |
|-------|----------------|
| **Telerik.Windows.Documents.Core** | The main package from the Telerik document processing libraries. You always need it when you intend to use the library. |
| **Telerik.Windows.Documents.Flow** | Part of the words (text) processing library. It is needed for processing HTML, DOCX, RTF and TXT documents. |
| **Telerik.Windows.Documents.DrawingML** | Part of the words (text) processing library. It is needed for working with shapes inside the documents. |
| **Telerik.Windows.Documents.Flow.FormatProviders.Doc** | Allows importing of DOC and DOT document. |
| **Telerik.Windows.Documents.Flow.FormatProviders.Pdf** | Allows exporting of flow documents (DOCX, DOC, DOT, RTF, and HTML) to PDF. |
| **Telerik.Documents.SpreadsheetStreaming** | The main package for generating huge spreadsheet files using minimum resources. |
| **Telerik.Windows.Documents.Spreadsheet** | The main package for the spreadsheet processing. It is needed for processing XLSX, CSV, TXT documents. |
| **Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml** | This package is needed for processing XLSX documents. |
| **Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls** | This package is needed for processing XLS documents. |
| **Telerik.Windows.Documents.Spreadsheet.FormatProviders.Pdf** | This package is needed for processing PDF documents. |
| **Telerik.Windows.Documents.Fixed** | Part of the PDF processing library. It is needed for working with PDF documents. |
| **Telerik.Windows.Documents.Fixed.FormatProviders.Ocr** | This package is needed for the [Optical Character Recognition (OCR)]({%slug radpdfprocessing-formats-and-conversion-ocr-ocrformatprovider%}) functionality. |
| **Telerik.Windows.Documents.Tesseract.Ocr** | This package is needed for the [Optical Character Recognition (OCR)]({%slug radpdfprocessing-formats-and-conversion-ocr-ocrformatprovider%}) functionality. |
| **Telerik.Windows.Documents.CMapUtils** | Provides a default implementation for getting the data of a predefined CMap table by a given name. The package is optional and you will need to include a reference to it only if you need to process documents with [CMap tables]({%slug radpdfprocessing-concepts-cmap-tables%}). |
| **Telerik.Windows.Zip** |It is the main package of the [Telerik Zip Library]({%slug radziplibrary-overview%}). |
| **Telerik.Windows.Zip.Extensions** | Extends **Telerik.Windows.Zip** package with additional helper methods ([Zip Extensions]({%slug radziplibrary-zipextensions%})). |


>The libraries support .NET 4.6.2 and later. .NET Standard-compatible packages are available as well. The packages for .NET Standard don't include 'Windows' in their names.
You can find all Document Processing Libraries packages in the [Available NuGet Packages]({%slug available-nuget-packages%}) article.

## Getting Started Resources by Library

Expand Down
7 changes: 3 additions & 4 deletions introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,9 @@ The Telerik Document Processing libraries support the following file formats:

![DPL Ninja](images/dpl-formats.png)

## Required References
## Distribution

>The Telerik Document Processing libraries are available in **.NET Framework**, **{{site.dotnetversions}}** (or newer) for Windows and **.NET Standard** compatible versions. You can download the references for these libraries from the following products:
>
The Telerik Document Processing libraries are available in **.NET Framework**, **{{site.dotnetversions}}** (or newer) for Windows and **.NET Standard 2.0 (Support for {{site.dotnetversions}})** compatible versions. You can download the references for the libraries from the following products:

|.NET Framework Products|{{site.dotnetversions}} *for Windows*|.NET Standard|
|----|----|----|
Expand All @@ -122,7 +121,7 @@ The Telerik Document Processing libraries support the following file formats:
|[UI for WinForms](https://www.telerik.com/products/winforms.aspx)|[UI for WinForms](https://www.telerik.com/products/winforms.aspx)|[UI for WinUI](https://www.telerik.com/winui)|
|[UI for Silverlight (discontinued)](https://www.telerik.com/products/silverlight/overview.aspx)||[UI for .NET MAUI](https://www.telerik.com/maui-ui)|

All versions are available as [NuGet packages]({%slug installation-nuget-packages%}). The packages for .NET Standard do not contain the word *Windows* in their name. Learn [What Versions of Document Processing Libraries are Distributed with the Telerik Products]({%slug distribute-telerik-document-processing-libraries-net-versions%})
You can find all packages in the [Available NuGet Packages]({%slug available-nuget-packages%}) article.

## Getting Started

Expand Down
104 changes: 5 additions & 99 deletions libraries/radpdfprocessing/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,118 +13,24 @@ This article will get you started in using the __RadPdfProcessing__ library.

>note If you still don't have **Telerik Document Processing** installed, check the [First Steps]({%slug getting-started-first-steps%}) topic to learn how you can obtain the packages through the different suites.

## Package References

>The libraries support {{site.dotnetversions}}. .NET Standard-compatible packages are available as well. The packages for .NET Standard don't include 'Windows' in their names (e.g. **Telerik.Documents.Core**). For more information check [**Cross-Platform Support**]({%slug radpdfprocessing-cross-platform%}) article.

In order to use the __RadPdfProcessing__ library in your project, you need to add references to the following packages:
<table>
<thead>
<tr>
<th>.NET Framework </th>
<th>.NET Standard-compatible</th>
</tr>
</thead>
<tbody>
<tr>
<td><b>Telerik.Windows.Documents.Core</b></td>
<td><b>Telerik.Documents.Core</b></td>
</tr>
<tr>
<td><b>Telerik.Windows.Documents.Fixed</b></td>
<td><b>Telerik.Documents.Fixed</b></td>
</tr>
<tr>
<td colspan="2">&nbsp;</td>
</tr>
<tr>
<td><b>Telerik.Windows.Documents.Fixed.FormatProviders.Ocr</b></td>
<td><b>Telerik.Documents.Fixed.FormatProviders.Ocr</b></td>
</tr>
<tr>
<td colspan="2">
This reference is recommended to always be in the form of a NuGet package, as it will add the required Tesseract references and files automatically. Otherwise, a
<a href="https://docs.telerik.com/devtools/document-processing/libraries/radpdfprocessing/formats-and-conversion/ocr/prerequisites#manually-set-up-the-tesseract-native-assemblies">manual intervention</a> might be required.
</td>
</tr>
<tr>
<td><b>Telerik.Windows.Documents.Tesseract.Ocr</b></td>
<td><b>Telerik.Documents.Tesseract.Ocr</b></td>
</tr>
<tr>
<td colspan="2">&nbsp;</td>
</tr>
<tr>
<td colspan="2">To export images different than <b>Jpeg</b> and <b>Jpeg2000</b> or ImageQuality different than High you will need to add a reference to the following package:</td>
</tr>
<tr>
<td><b>-</b></td>
<td><b>Telerik.Documents.ImageUtils</b>
<br><sub><i>This package is not available in UI for Xamarin.</i></sub>
</tr>
<tr>
<td colspan="2" >This package is required for the <a href="https://docs.telerik.com/devtools/document-processing/libraries/radpdfprocessing/formats-and-conversion/convert-to-image/using-image-format-provider">Image Exporting</a> functionality. This is only available in the NET Standard version. </td>
</tr>
<tr>
<td><b>-</b></td>
<td><b>Telerik.Documents.Fixed.FormatProviders.Image.Skia</b></td>
</tr>
<tr>
<td colspan="2">&nbsp;</td>
</tr>
<tr>
<td colspan="2">To enable the import of documents containing <a href="https://docs.telerik.com/devtools/document-processing/libraries/radpdfprocessing/concepts/cmaps">CMap Tables</a>, you will need to add a reference to:</td>
</tr>
<tr>
<td><b>Telerik.Windows.Documents.CMapUtils</b></td>
<td><b>Telerik.Documents.CMapUtils</b></td>
</tr>
<tr>
<td colspan="2">&nbsp;</td>
</tr>
<tr>
<td colspan="2">To describe different colors, shapes and other properties, <b>RadPdfProcessing</b> depends on the listed below .NET assemblies, which you should also refer in your project:</td>
</tr>
<tr>
<td><b>WindowsBase.dll</b></td>
<td><b>-</b></td>
</tr>
<tr>
<td><b>PresentationCore.dll</b></td>
<td><b>-</b></td>
</tr>
<tr>
<td><b>PresentationFramework.dll</b></td>
<td><b>-</b></td>
</tr>
</tbody>
</table>

>note The **Telerik.Documents.ImageUtils** package depends on **SkiaSharp**. In order to use this package, you will need to add a reference to [SkiaSharp](https://www.nuget.org/packages/SkiaSharp/). With the [R2 2023 changes](https://docs.telerik.com/devtools/document-processing/libraries/radpdfprocessing/changes-and-backward-compatibility/backward-compatibility#whats-different-in-2023-r2) SkiaSharp replaced ImageSharp as the required dependency.

>note The **Telerik.Documents.Fixed.FormatProviders.Image.Skia** package depends on **SkiaSharp**. In order to use this package, you will need to add a reference to [SkiaSharp](https://www.nuget.org/packages/SkiaSharp/). The **SkiaSharp.NativeAssets.*** Nuget package is required as well. This package may differ according to the used platform. There are version for Windows, MacOs, Linux, WebAssembly, Android, iOS, and others.

## Required References

You can find the required references in the [PdfProcessing NuGet packages]({%slug available-nuget-packages%}#pdfprocessing-packages) section.

## Creating a Document

[RadFixedDocument]({%slug radpdfprocessing-model-radfixeddocument%}) is the root element in the library. It consists of [RadFixedPage]({%slug radpdfprocessing-model-radfixedpage%}) objects and instructions for annotations and destinations in the document. __Example 1__ shows how to create a document and add a page to it.

[RadFixedDocument]({%slug radpdfprocessing-model-radfixeddocument%}) is the root element in the library. It consists of [RadFixedPage]({%slug radpdfprocessing-model-radfixedpage%}) objects and instructions for annotations and destinations in the document. __Example 1__ shows how to create a document and add a page to it.

#### __Example 1: Create RadFixedDocument__

<snippet id='pdf-create-fixed'/>



The page can then be edited through a [FixedContentEditor]({%slug radpdfprocessing-editing-fixedcontenteditor%}) instance. __Example 2__ creates an editor and adds a [TextFragment]({%slug radpdfprocessing-model-textfragment%}) to the page object created in __Example 1__.

The page can then be edited through a [FixedContentEditor]({%slug radpdfprocessing-editing-fixedcontenteditor%}) instance. __Example 2__ creates an editor and adds a [TextFragment]({%slug radpdfprocessing-model-textfragment%}) to the page object created in __Example 1__.

#### __Example 2: Add text__

<snippet id='pdf-create-editor'/>



## Exporting to PDF

Exporting to PDF format can be achieved with the __PdfFormatProvider__ class. __Example 3__ shows how to export the __RadFixedDocument__ created in __Examples 1 and 2__ to a file.
Expand Down
Loading