diff --git a/getting-started/Installation/install-nuget-packages.md b/getting-started/Installation/install-nuget-packages.md index ec4bc07f..d5544c2f 100644 --- a/getting-started/Installation/install-nuget-packages.md +++ b/getting-started/Installation/install-nuget-packages.md @@ -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) @@ -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. diff --git a/getting-started/Installation/nuget-packages.md b/getting-started/Installation/nuget-packages.md index c9cc92b1..753b8c32 100644 --- a/getting-started/Installation/nuget-packages.md +++ b/getting-started/Installation/nuget-packages.md @@ -14,18 +14,11 @@ Telerik provides NuGet packages with the assemblies for all five Document Proces If your workflow relies on NuGet for package management, you can take advantage of the packages that we describe in this article. There is no need to download and install the Document Processing libraries by using other methods. -#### This article contains the following sections: - -* [NuGet packages for .NET Framework and {{site.dotnetversions}} for Windows](#packages-for-net-framework-and-net-core-for-windows) -* [Packages for .NET Standard 2.0 (Support for {{site.dotnetversions}})](#packages-for-net-standard-20-net-core-net-6-net-8) -* [Get the NuGet Packages](#get-the-nuget-packages) - - >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 Framework and {{site.dotnetversions}} for Windows** > ->* A version for __.Net Standard 2.0__ +>* A version for **.NET Standard 2.0 (Support for {{site.dotnetversions}})** > >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. @@ -37,73 +30,304 @@ If your workflow relies on NuGet for package management, you can take advantage >note As of **Q2 2025** the Zip Library will no longer be used as an internal dependency in the rest of the Document Processing Libraries - PdfProcessing, WordsProcessing, SpreadProcessing, SpreadStreamProcessing. It will be replaced by the System.IO.Compression. We will continue to ship the Telerik Zip Library as a standalone library so clients can still use it separately. -## Packages for .NET Framework and {{site.dotnetversions}} for Windows - -The following list represents the available NuGet packages for the Document Processing libraries that you can use with the .NET Framework or {{site.dotnetversions}} for Windows. Although we offer them as an addition to the Telerik UI components, you can use them without any UI components: - -* __Telerik.Windows.Documents.Core:__ The main NuGet package for the Telerik Document Processing libraries. Required when you plan to use the library. -* __Telerik.Windows.Documents.Fixed:__ The package is required when processing `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.TesseractOcr:__ 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. -* __Telerik.Windows.Documents.Flow:__ The package is part of the WordsProcessing library. Required for processing `HTML`, `DOCX`, `RTF`, and `TXT` documents. -* __Telerik.Windows.Documents.DrawingML:__ Part of the WordsProcessing library. It is needed for working with shapes inside the documents. -* __Telerik.Windows.Documents.Flow.FormatProviders.Doc:__ This package is required for importing DOC documents. -* __Telerik.Windows.Documents.Flow.FormatProviders.Pdf:__ The package for exporting flow documents, such as `DOCX` and `RTF`, to `PDF`. -* __Telerik.Windows.Documents.Spreadsheet:__ The main package for generating spreadsheets. -* __Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml:__ This package is required for the import/export of `XLSX` documents. -* __Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls:__ This package is required for the import/export of `XLS` documents. -* __Telerik.Windows.Documents.Spreadsheet.FormatProviders.Pdf:__ Required for the export of RadSpreadProcessing documents to `PDF`. -* __Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json:__ Required for the export of RadSpreadProcessing documents to `JSON` format. -* __Telerik.Windows.Documents.SpreadsheetStreaming:__ The main package for generating huge spreadsheet files while using minimum resources. -* __Telerik.Windows.Documents.AIConnector:__ This package is required for using the GenAI-powered Document Insights feature. - * __Telerik.Documents.AI.Core:__ This package is a dependency of __Telerik.Documents.AIConnector__. - * __Telerik.Documents.AI.RAG:__ This package is a dependency of __Telerik.Documents.AIConnector__. -* __Telerik.Documents.AI.Tools.Core:__ Core types and interfaces for the Agent Tools infrastructure. -* __Telerik.Documents.AI.Tools.Spreadsheet.Core:__ Repository and core types for spreadsheet processing. -* __Telerik.Documents.AI.Tools.Fixed.Core:__ Repository and core types for PDF document processing. -* __Telerik.Documents.AI.Tools.Flow.Core:__ Repository and core types for flow document processing. -* __Telerik.Documents.AI.Tools.Conversion.Core:__ Core types for document conversion operations. -* __Telerik.Documents.AI.AgentTools.Spreadsheet:__ Agent tool classes for spreadsheet operations. -* __Telerik.Documents.AI.AgentTools.Fixed:__ Agent tool classes for PDF document operations. -* __Telerik.Documents.AI.AgentTools.Conversion:__ Agent tool classes for document conversion and merging. -* __Telerik.Windows.Zip:__ It can be used as a standalone library as well. -* __Telerik.Windows.Zip.Extensions:__ The package provides methods for working with files and platform specific operations. - -## Packages for .NET Standard 2.0 (Support for {{site.dotnetversions}}) - -The following list represents the available NuGet packages for the Document Processing libraries that you can use with [.NET Standard 2.0](https://github.com/dotnet/standard/blob/master/docs/versions/netstandard2.0.md): - -* __Telerik.Documents.Core:__ The main NuGet package from the Telerik Document Processing libraries. Required when you plan to use the library. -* __Telerik.Documents.Fixed:__ The package is required when processing `PDF` documents. -* __Telerik.Documents.Fixed.FormatProviders.Image.Skia:__ The package is required for the cross-patform [SkiaTextMeasurer]({%slug radspreadprocessing-cross-platform-text-measure%}#skiatextmeasurer). - * __Telerik.Text.Skia:__ The package is a dependency of __Telerik.Documents.Fixed.FormatProviders.Image.Skia__. -* __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.TesseractOcr:__ 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. -* __Telerik.Documents.Flow:__ The package is part of the Words Processing Library. Required for processing `HTML`, `DOCX`, `RTF`, and `TXT` documents. -* __Telerik.Documents.DrawingML:__ Part of the WordsProcessing library. It is needed for working with shapes inside the documents. -* __Telerik.Documents.Flow.FormatProviders.Doc:__ This package is required for importing DOC documents. -* __Telerik.Documents.Flow.FormatProviders.Pdf:__ The package for exporting flow documents, such as `DOCX` and `RTF`, to PDF. -* __Telerik.Documents.Spreadsheet:__ The main package for generating and editing spreadsheets. -* __Telerik.Documents.Spreadsheet.FormatProviders.OpenXml:__ This package is required for the import/export of `XLSX` documents. -* __Telerik.Documents.Spreadsheet.FormatProviders.Xls:__ This package is required for the import/export of `XLS` documents. -* __Telerik.Documents.Spreadsheet.FormatProviders.Pdf:__ Required for the export of RadSpreadProcessing documents to `PDF`. -* __Telerik.Documents.Spreadsheet.FormatProviders.Json:__ Required for the export of RadSpreadProcessing documents to `JSON` format. -* __Telerik.Documents.SpreadsheetStreaming:__ The main package for generating huge spreadsheet files while using minimum resources. -* __Telerik.Documents.AIConnector:__ This package is required for using the GenAI-powered Document Insights feature. - * __Telerik.Documents.AI.Core:__ This package is a dependency of __Telerik.Documents.AIConnector__. - * __Telerik.Documents.AI.RAG:__ This package is a dependency of __Telerik.Documents.AIConnector__. -* __Telerik.Documents.AI.Tools.Core:__ Core types and interfaces for the Agent Tools infrastructure. -* __Telerik.Documents.AI.Tools.Spreadsheet.Core:__ Repository and core types for spreadsheet processing. -* __Telerik.Documents.AI.Tools.Fixed.Core:__ Repository and core types for PDF document processing. -* __Telerik.Documents.AI.Tools.Flow.Core:__ Repository and core types for flow document processing. -* __Telerik.Documents.AI.Tools.Conversion.Core:__ Core types for document conversion operations. -* __Telerik.Documents.AI.AgentTools.Spreadsheet:__ Agent tool classes for spreadsheet operations. -* __Telerik.Documents.AI.AgentTools.Fixed:__ Agent tool classes for PDF document operations. -* __Telerik.Documents.AI.AgentTools.Conversion:__ Agent tool classes for document conversion and merging. -* __Telerik.Zip:__ It can be used as a standalone library as well. +The following tables represent the available NuGet packages for the Document Processing libraries. Each table shows the package names for both .NET Framework and {{site.dotnetversions}} for Windows, as well as .NET Standard 2.0 (Support for {{site.dotnetversions}}) versions. Although we offer them as an addition to the Telerik UI components, you can use them without any UI components. + +### Core Packages + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
.NET Framework and {{site.dotnetversions}} for Windows.NET Standard 2.0 (Support for {{site.dotnetversions}})
Telerik.Windows.Documents.CoreTelerik.Documents.Core
The main NuGet package for the Telerik Document Processing libraries. Required when you plan to use the library.
Telerik.Windows.Documents.CMapUtilsTelerik.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.
N/ATelerik.Documents.ImageUtils +
This package is not available in UI for Xamarin.
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 article. The package also depends on SkiaSharp. In order to use it, you will need to add a reference to SkiaSharp. +
Telerik.Windows.Documents.AIConnectorTelerik.Documents.AIConnector
This package is required for using the GenAI-powered Document Insights feature.
Telerik.Documents.AI.CoreTelerik.Documents.AI.Core
This package is a dependency of Telerik.Documents.AIConnector.
Telerik.Documents.AI.RAGTelerik.Documents.AI.RAG
This package is a dependency of Telerik.Documents.AIConnector.
Telerik.Documents.AI.Tools.CoreTelerik.Documents.AI.Tools.Core
Core types and interfaces for the Agent Tools infrastructure.
Telerik.Documents.AI.Tools.Conversion.CoreTelerik.Documents.AI.Tools.Conversion.Core
Core types for document conversion operations.
Telerik.Documents.AI.AgentTools.ConversionTelerik.Documents.AI.AgentTools.Conversion
Agent tool classes for document conversion and merging.
+ +### PdfProcessing packages + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
.NET Framework and {{site.dotnetversions}} for Windows.NET Standard 2.0 (Support for {{site.dotnetversions}})
Telerik.Windows.Documents.FixedTelerik.Documents.Fixed
The package is required when processing PDF documents.
N/ATelerik.Documents.Fixed.FormatProviders.Image.Skia
The package is required for the cross-patform SkiaTextMeasurer. The package depends on SkiaSharp. In order to use this package, you will need to add a reference to SkiaSharp. The SkiaSharp.NativeAssets.* NuGet package is required as well. This package may differ according to the used platform. There are versions for Windows, MacOS, Linux, WebAssembly, Android, iOS, and others.
N/ATelerik.Text.Skia
The package is a dependency of Telerik.Documents.Fixed.FormatProviders.Image.Skia.
Telerik.Windows.Documents.Fixed.FormatProviders.OcrTelerik.Documents.Fixed.FormatProviders.Ocr
This package is needed for the Optical Character Recognition (OCR) functionality. 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 manual intervention might be required.
Telerik.Windows.Documents.TesseractOcrTelerik.Documents.TesseractOcr
This package is needed for the Optical Character Recognition (OCR) functionality.
Telerik.Documents.AI.Tools.Fixed.CoreTelerik.Documents.AI.Tools.Fixed.Core
Repository and core types for PDF document processing.
Telerik.Documents.AI.AgentTools.FixedTelerik.Documents.AI.AgentTools.Fixed
Agent tool classes for PDF document operations.
+ +### WordsProcessing packages + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
.NET Framework and {{site.dotnetversions}} for Windows.NET Standard 2.0 (Support for {{site.dotnetversions}})
Telerik.Windows.Documents.FlowTelerik.Documents.Flow
The package is part of the WordsProcessing library. Required for processing HTML, DOCX, RTF, and TXT documents.
Telerik.Windows.Documents.DrawingMLTelerik.Documents.DrawingML
Part of the WordsProcessing library. It is needed for working with shapes inside the documents.
Telerik.Windows.Documents.Flow.FormatProviders.DocTelerik.Documents.Flow.FormatProviders.Doc
This package is required for importing DOC and DOT documents.
Telerik.Windows.Documents.Flow.FormatProviders.PdfTelerik.Documents.Flow.FormatProviders.Pdf
Allows exporting of flow documents (DOCX, DOC, DOT, RTF, and HTML) to PDF.
Telerik.Documents.AI.Tools.Flow.CoreTelerik.Documents.AI.Tools.Flow.Core
Repository and core types for flow document processing.
+ +### SpreadProcessing packages + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
.NET Framework and {{site.dotnetversions}} for Windows.NET Standard 2.0 (Support for {{site.dotnetversions}})
Telerik.Windows.Documents.SpreadsheetTelerik.Documents.Spreadsheet
The main package for generating and editing spreadsheets. It is needed for processing XLSX, CSV, and TXT documents.
Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXmlTelerik.Documents.Spreadsheet.FormatProviders.OpenXml
This package is required for the import/export of XLSX documents.
Telerik.Windows.Documents.Spreadsheet.FormatProviders.XlsTelerik.Documents.Spreadsheet.FormatProviders.Xls
This package is required for the import/export of XLS documents.
Telerik.Windows.Documents.Spreadsheet.FormatProviders.PdfTelerik.Documents.Spreadsheet.FormatProviders.Pdf
Required for the export of RadSpreadProcessing documents to PDF.
Telerik.Windows.Documents.Spreadsheet.FormatProviders.JsonTelerik.Documents.Spreadsheet.FormatProviders.Json
Required for the export of RadSpreadProcessing documents to JSON format. Supports export only. No JSON import.
Telerik.Documents.AI.Tools.Spreadsheet.CoreTelerik.Documents.AI.Tools.Spreadsheet.Core
Repository and core types for spreadsheet processing.
Telerik.Documents.AI.AgentTools.SpreadsheetTelerik.Documents.AI.AgentTools.Spreadsheet
Agent tool classes for spreadsheet operations.
+ +### SpreadStreamProcessing packages + + + + + + + + + + + + + + + + + +
.NET Framework and {{site.dotnetversions}} for Windows.NET Standard 2.0 (Support for {{site.dotnetversions}})
Telerik.Windows.Documents.SpreadsheetStreamingTelerik.Documents.SpreadsheetStreaming
The main package for generating huge spreadsheet files while using minimum resources.
+ +### ZipLibrary packages + + + + + + + + + + + + + + + + + + + + + + + + +
.NET Framework and {{site.dotnetversions}} for Windows.NET Standard 2.0 (Support for {{site.dotnetversions}})
Telerik.Windows.ZipTelerik.Zip
It is the main package of the Telerik Zip Library. It can be used as a standalone library as well.
Telerik.Windows.Zip.ExtensionsN/A
Extends Telerik.Windows.Zip package with additional helper methods (Zip Extensions). The package provides methods for working with files and platform specific operations.
## See Also diff --git a/getting-started/first-steps.md b/getting-started/first-steps.md index 238487eb..d0c406a7 100644 --- a/getting-started/first-steps.md +++ b/getting-started/first-steps.md @@ -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 diff --git a/getting-started/getting-started.md b/getting-started/getting-started.md index ca2246d7..489aeb73 100644 --- a/getting-started/getting-started.md +++ b/getting-started/getting-started.md @@ -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 diff --git a/introduction.md b/introduction.md index e09f581a..c4ec0680 100644 --- a/introduction.md +++ b/introduction.md @@ -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| |----|----|----| @@ -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 diff --git a/libraries/radpdfprocessing/getting-started.md b/libraries/radpdfprocessing/getting-started.md index d8d2d745..6f340e24 100644 --- a/libraries/radpdfprocessing/getting-started.md +++ b/libraries/radpdfprocessing/getting-started.md @@ -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: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.NET Framework .NET Standard-compatible
Telerik.Windows.Documents.CoreTelerik.Documents.Core
Telerik.Windows.Documents.FixedTelerik.Documents.Fixed
 
Telerik.Windows.Documents.Fixed.FormatProviders.OcrTelerik.Documents.Fixed.FormatProviders.Ocr
- 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 - manual intervention might be required. -
Telerik.Windows.Documents.Tesseract.OcrTelerik.Documents.Tesseract.Ocr
 
To export images different than Jpeg and Jpeg2000 or ImageQuality different than High you will need to add a reference to the following package:
-Telerik.Documents.ImageUtils -
This package is not available in UI for Xamarin. -
This package is required for the Image Exporting functionality. This is only available in the NET Standard version.
-Telerik.Documents.Fixed.FormatProviders.Image.Skia
 
To enable the import of documents containing CMap Tables, you will need to add a reference to:
Telerik.Windows.Documents.CMapUtilsTelerik.Documents.CMapUtils
 
To describe different colors, shapes and other properties, RadPdfProcessing depends on the listed below .NET assemblies, which you should also refer in your project:
WindowsBase.dll-
PresentationCore.dll-
PresentationFramework.dll-
- ->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__ - - -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__ - - ## 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. diff --git a/libraries/radspreadprocessing/getting-started.md b/libraries/radspreadprocessing/getting-started.md index 02e75a88..1c4d8f5a 100644 --- a/libraries/radspreadprocessing/getting-started.md +++ b/libraries/radspreadprocessing/getting-started.md @@ -9,104 +9,18 @@ position: 1 # Getting Started - -This article will get you started in using the __RadSpreadProcessing__ library. It contains the following sections: - - -* [Package References](#package-references) - -* [Creating a Workbook](#creating-a-workbook) - -* [Exporting](#exporting) - -* [Using RadSpreadsheet](#using-radspreadsheet) +This article will get you started in using the __RadSpreadProcessing__ 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 radspreadprocessing-cross-platform%}) article. - -In order to use the model of the __RadSpreadProcessing__ library in your project, you need to add references to the following packages: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.NET Framework .NET Standard-compatibleAdditional information
Telerik.Windows.Documents.CoreTelerik.Documents.Core
Telerik.Windows.Documents.SpreadsheetTelerik.Documents.Spreadsheet
Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXmlTelerik.Documents.Spreadsheet.FormatProviders.OpenXmlRequired when importing/exporting from/to XLSX or CSV.
Telerik.Windows.Documents.Spreadsheet.FormatProviders.XlsTelerik.Documents.Spreadsheet.FormatProviders.XlsRequired when importing/exporting from/to XLS.
Telerik.Windows.Documents.Spreadsheet.FormatProviders.PdfTelerik.Documents.Spreadsheet.FormatProviders.PdfRequired when exporting to PDF.
Telerik.Windows.Documents.FixedTelerik.Documents.FixedRequired when exporting to PDF.
- - Telerik.Documents.ImageUtils -
This package is not available in UI for Xamarin. - 		*
 
To describe different colors, shapes and other properties, RadSpreadProcessing depends on the listed below .NET assemblies, which you should also refer in your project:
WindowsBase.dll-
PresentationCore.dll-
PresentationFramework.dll-
- ->note Needed when exporting to PDF format a document containing images different than Jpeg and Jpeg2000 or ImageQuality different than High. The **Telerik.Documents.ImageUtils** package depends on **SkiaSharp**. In order to use this package, you will need to add а 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. +You can find the required references in the [SpreadProcessing NuGet packages]({%slug available-nuget-packages%}#spreadprocessing-packages) section. ## Creating a Workbook The document model allows you to instantiate a new [workbook]({%slug radspreadprocessing-working-with-workbooks-what-is-workbook%}) and populate it with any data you want. - __Example 1__ shows how you can create a workbook and add a new worksheet to it. @@ -117,8 +31,6 @@ __Example 1__ shows how you can create a workbook and add a new worksheet to it. Worksheet worksheet = workbook.Worksheets.Add(); ``` - - You can then create a [CellSelection]({%slug radspreadprocessing-working-with-cells-get-set-clear-properties%}) and set any value to the selected cells. __Example 2__ shows how you can create a cell and set a string value to it. @@ -129,8 +41,6 @@ You can then create a [CellSelection]({%slug radspreadprocessing-working-with-ce selection.SetValue("Hello RadSpreadProcessing"); ``` - - ## Exporting The __RadSpreadProcessing__ library supports a variety of formats to which you can export the contents of a workbook using [FormatProviders]({%slug radspreadprocessing-formats-and-conversion-general-information%}). __Example 3__ shows how you can export the previously created workbook to `.xlsx` format. @@ -159,7 +69,6 @@ For more complete examples head to the [Developer Focused Examples]({%slug radsp __RadSpreadsheet__ is a UI control part of the Telerik UI for WPF/Silverlight suites. The document model explained in this section of the documentation and all its features are shared between the __RadSpreadProcessing__ library and __RadSpreadsheet__. [This help section](http://docs.telerik.com/devtools/wpf/controls/radspreadsheet/overview.html) contains information about all UI-specific features of __RadSpreadsheet__. - ## See Also * [Using Telerik Document Processing First Steps]({%slug getting-started-first-steps%}) @@ -172,4 +81,4 @@ __RadSpreadsheet__ is a UI control part of the Telerik UI for WPF/Silverlight su * [Getting Started with RadSpreadProcessing Volume 1](https://www.telerik.com/blogs/getting-started-with-radspreadprocessing-volume-1) * [Getting started with RadSpreadProcessing Vol2](https://www.telerik.com/blogs/getting-started-with-radspreadprocessing-vol2) * [Getting Started with RadSpreadProcessing Vol3](https://www.telerik.com/blogs/getting-started-with-radspreadprocessing-vol3) - * [SpreadProcessing Document Generation Demo](https://demos.telerik.com/document-processing/spreadprocessing/generate_documents) + * [SpreadProcessing Document Generation Demo](https://demos.telerik.com/document-processing/spreadprocessing/generate_documents) \ No newline at end of file diff --git a/libraries/radspreadstreamprocessing/getting-started.md b/libraries/radspreadstreamprocessing/getting-started.md index d95bf7d1..2a76fed4 100644 --- a/libraries/radspreadstreamprocessing/getting-started.md +++ b/libraries/radspreadstreamprocessing/getting-started.md @@ -9,52 +9,13 @@ position: 1 # Getting Started -This article will get you started in using the **RadSpreadStreamProcessing** library. It contains the following sections: - -* [Package References](#package-references) - -* [Supported Formats](#supported-formats) - -* [Create a Spreadsheet Document](#create-a-spreadsheet-document) +This article will get you started in using the **RadSpreadStreamProcessing** 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.Zip.**). - -In order to use **RadSpreadStreamProcessing** in your project, you will need to add the references listed below. - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.NET Framework .NET Standard-compatible
Telerik.Documents.SpreadsheetStreamingTelerik.Documents.SpreadsheetStreaming
 
To describe different colors, shapes and other properties, RadSpreadStreamProcessing depends on the listed below .NET assemblies, which you should also refer in your project:
WindowsBase.dll-
PresentationFramework.dll-
- ->note The binaries compatible with .NET Standard are distributed with the packages targeting .NET Standard and {{site.dotnetversions}}. For the full list of suites including Telerik Document Processing, check the [Installing on Your Computer]({%slug installation-installing-on-your-computer%}) help topic. There are **NuGet** packages as well that you can access if you have a license for one of the above mentioned suites. +You can find the required references in the [SpreadStreamProcessing NuGet packages]({%slug available-nuget-packages%}#spreadstreamprocessing-packages) section. ## Create a Spreadsheet Document diff --git a/libraries/radwordsprocessing/getting-started.md b/libraries/radwordsprocessing/getting-started.md index c944f4a2..cd1265f3 100644 --- a/libraries/radwordsprocessing/getting-started.md +++ b/libraries/radwordsprocessing/getting-started.md @@ -11,96 +11,11 @@ position: 1 This tutorial will take you through the creation of a sample application that uses RadWordsProcessing. -* [Package References](#package-references) - -* [Creating RadFlowDocument from Code](#creating-radflowdocument-from-code) - -* [Exporting RadFlowDocument to Docx](#exporting-radflowdocument-to-docx) - ->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. +>noteIf 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 radwordsprocessing-cross-platform%}) article. - -Here is a list of packages that contain the __RadWordsProcessing__ functionality and need to be referenced in your project: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
.NET Framework .NET Standard-compatible
Telerik.Windows.Documents.CoreTelerik.Documents.Core
Telerik.Windows.Documents.FlowTelerik.Documents.Flow
Telerik.Windows.Documents.DrawingMLTelerik.Documents.DrawingML
 
If you need to import DOC or DOT files, you will need to refer the following packages:
Telerik.Windows.Documents.Flow.FormatProviders.DocTelerik.Documents.Flow.FormatProviders.Doc
 
If you need to export documents to PDF format, you will need to refer the following packages:
Telerik.Windows.Documents.Flow.FormatProviders.PdfTelerik.Documents.Flow.FormatProviders.Pdf
Telerik.Windows.Documents.FixedTelerik.Documents.Fixed
-Telerik.Documents.ImageUtils* -
This package is not available in UI for Xamarin. -
 
To describe different colors, shapes and other properties, RadWordsProcessing depends on the listed below .NET assemblies, which you should also refer in your project:
WindowsBase.dll-
PresentationCore.dll-
PresentationFramework.dll-
- - - * The Telerik.Documents.ImageUtils package is needed when exporting to PDF format a document containing images different than Jpeg and Jpeg2000 or ImageQuality different than High. - - ->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. +You can find the required references in the [WordsProcessing NuGet packages]({%slug available-nuget-packages%}#wordsprocessing-packages) section. ## Creating RadFlowDocument from Code diff --git a/libraries/radziplibrary/gettingstarted.md b/libraries/radziplibrary/gettingstarted.md index 3487a622..f9d88db6 100644 --- a/libraries/radziplibrary/gettingstarted.md +++ b/libraries/radziplibrary/gettingstarted.md @@ -15,7 +15,6 @@ __RadZipLibrary__ allows you to load data from existing ZIP archives or create a >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. The ZIP archive is represented by __ZipArchive__ class. It can be used in 3 modes: - * __Read__: Allows reading of the existing ZIP archive. In this mode it is not possible to add or update archive entries. @@ -23,25 +22,9 @@ The ZIP archive is represented by __ZipArchive__ class. It can be used in 3 mode * __Update__: Allows update of the existing ZIP archive. In this mode you can add new entries, read and update existing entries. -## Assembly 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.Zip**). - - - - - - - - - - - - - -
.NET Framework .NET Standard-compatible
Telerik.Windows.ZipTelerik.Zip
+## Required References ->note The binaries compatible with .NET Standard are distributed with the packages targeting .NET Standard and .NET Core. You can obtain the packages through the **UI for ASP.NET Core**, **UI for Blazor** and **UI for Xamarin** suites. There are **NuGet** packages as well that you can access if you have a license for one of the above mentioned suites. +You can find the required references in the [ZipLibrary NuGet packages]({%slug available-nuget-packages%}#ziplibrary-packages) section. ## Open Zip Archive @@ -63,7 +46,6 @@ The code snippet from __Example 1__ demonstrates how to open existing Zip archiv The *archive* variable holds the files that are compressed in the selected zip. You can access the list of these files through the __ZipArchive.Entries__ property. It holds a collection of [ZipArchiveEntry]({%slug radziplibrary-update-ziparchive%}) elements - the elements that describe the files archived in the zip file. You can use these elements to get the name of the compressed file, its uncompressed and compressed size and other file attributes. - ## Create Zip Archive __Example 2__ shows how to create a new Zip archive using the __ZipArchive__ class and place a text file in it. @@ -89,7 +71,6 @@ __Example 2__ shows how to create a new Zip archive using the __ZipArchive__ cla >tip If you use __StreamWriter__ to write content to the stream, you should call the Flush() method in order to flush the data to the stream. - >Do not close the stream opened by the __ZipArchiveEntry.Open()__ method. Otherwise the result is unpredictable. The constructor of ZipArchive lets you specify whether you would like to keep the stream associated to the instance open. If you decide to set the `leaveOpen` parameter to `false`, the underlying stream will be closed once the ZipArchive instance is disposed. In case you need to continue working with that stream (to send it as a responce, for example), you should pass `true` for the `leaveOpen` parameter.