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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ publish: false

# Telerik Document Processing Public Documentation

Welcome to the GitHub repo for [Telerik Document Processing](). This repository contains the source content — written in Markdown — that we use to power the Telerik Document Processing Documentation at [docs.telerik.com/devtools/document-processing](http://docs.telerik.com/devtools/document-processing). If you've arrived here wanting to search and peruse our docs, you'd be better served heading over to [docs.telerik.com/devtools/document-processing](http://docs.telerik.com/devtools/document-processing) where our content is prettified and searchable.
Welcome to the GitHub repo for [Telerik Document Processing](). This repository contains the source content — written in Markdown — that we use to power the Telerik Document Processing Documentation at [docs.telerik.com/devtools/document-processing](https://docs.telerik.com/devtools/document-processing). If you have arrived here wanting to search and peruse the docs, you are better served heading over to [docs.telerik.com/devtools/document-processing](https://docs.telerik.com/devtools/document-processing) where the content is prettified and searchable.

We believe that the documentation for a product is at its best when the content is a collaboration between the builders and consumers of that product. As such, this documentation is both public, and open sourced under an MIT license (see below). That means you can clone this repository, read the docs off line, or even load the entire thing to an Apple Newton, if that's your thing.
We believe that the documentation for a product is at its best when the content is a collaboration between the builders and consumers of that product. As such, this documentation is both public, and open sourced under an MIT license (see below). That means you can clone this repository, read the docs offline, or even load the entire thing to an Apple Newton, if that is your thing.

It also means that you can play a role in making our docs better for everyone, and if helping us make the Telerik Document Processing docs better sounds interesting to you, read on.

Expand All @@ -21,17 +21,17 @@ There are two ways you can contribute to the public Telerik Document Processing
Title: api/DataViz/chart.md is missing an image
Description : Example 3 is missing an image right after the code sample. https://github.com/telerik/xaml-docs/issues?state=open

> Note: When creating issues, please don't modify the assignee or milestone fields. Also, please create one issue per fix or change. "Bundled" entries will be deleted.
> Note: When creating issues, do not modify the assignee or milestone fields. Also, create one issue per fix or change. "Bundled" entries will be deleted.

* **Send us a pull request** - Creating an issue is great — and we certainly appreciate them — but what we really love are pull requests. So, if you find an issue in the docs, or even feel like creating new content, we'd be happy to have your contributions! If you're just getting started with open source, Git and GitHub, we suggest you first read up on [forking repositories](https://help.github.com/articles/fork-a-repo) and [sending pull requests](https://help.github.com/articles/using-pull-requests), both great articles from the GitHub bootcamp.
* **Send us a pull request** - Creating an issue is great — and we certainly appreciate them — but what we really love are pull requests. So, if you find an issue in the docs, or even feel like creating new content, we are happy to have your contributions! If you are getting started with open source, Git, and GitHub, we suggest you first read up on [forking repositories](https://help.github.com/articles/fork-a-repo) and [sending pull requests](https://help.github.com/articles/using-pull-requests), both great articles from the GitHub bootcamp.

Once you've read these — or you've already memorized them — you're ready to contribute to the Telerik Document Processing docs. Start by creating a local clone of our repo either using [GitHub for Windows](http://windows.github.com/), [GitHub for Mac](http://mac.github.com/) or your friendly command-line:
Once you have read these — or you have already memorized them — you are ready to contribute to the Telerik Document Processing docs. Start by creating a local clone of the repo either using [GitHub for Windows](https://windows.github.com/), [GitHub for Mac](https://mac.github.com/) or your friendly command-line:

git clone git@github.com:telerik/document-processing-docs.git

Then, open up the document-processing-docs folder in your favorite text editor and contribute away! Of course, as you work with the docs, we do ask that you follow a couple of ground rules:

- Fixing grammar, punctuation and other general errors is always appreciated. So are changes that expand on key ideas or correct errors in logic phrasing or otherwise. If your ambitions are greater, however, and you want to add completely new content to the site — like a new tutorial on using Document Processing with an Atari 2600, for instance — we suggest you contact a member of the team first (or enter an issue!) to vet your idea.
- Fixing grammar, punctuation, and other general errors is always appreciated. So are changes that expand on key ideas or correct errors in logic phrasing or otherwise. If your ambitions are greater, however, and you want to add completely new content to the site — like a new tutorial on using Document Processing with an Atari 2600, for instance — we suggest you contact a member of the team first (or enter an issue!) to vet your idea.
- Each document in this repo contains a section of YAML Front Matter at the very top. This content, which looks like the text below, is used by our auto-import tool when content is processed for the live documentation site. Please don't edit the content in this section of a document.

---
Expand All @@ -53,15 +53,15 @@ There are two ways you can contribute to the public Telerik Document Processing
---


- When adding content or making changes, please use only standard Markdown syntax, and make sure to preview your additions or changes before sending us a pull request. You can use an online tool like [Dillinger.io](http://dillinger.io/) or [Marked](http://markedapp.com/) on OSX to view what your changes will look like when ported to HTML.
- When adding content or making changes, use only standard Markdown syntax, and preview your additions or changes before sending us a pull request. You can use an online tool like [Dillinger.io](https://dillinger.io/) or [Marked](https://marked.js.org/) on macOS to view what your changes will look like when ported to HTML.

- The [documentation Wiki](https://github.com/telerik/document-processing-docs/wiki) contains the latest authoring guidelines.

Once you've made your changes, commit, pull, merge, push and [send us a pull request](https://help.github.com/articles/using-pull-requests)! We — and Telerik Document Processing users everywhere — thank you for making our docs the best front-end library documentation on the web!
Once you have made your changes, commit, pull, merge, push, and [send us a pull request](https://help.github.com/articles/using-pull-requests)! We — and Telerik Document Processing users everywhere — thank you for making our docs the best front-end library documentation on the web!

## Running locally
## Running Locally

You can generate a static web site from the Telerik Document Processing the documentation and browse it locally.
You can generate a static website from the Telerik Document Processing documentation and browse it locally.

For the Telerik Document Processing documentation:

Expand All @@ -73,7 +73,7 @@ For the Telerik Document Processing documentation:

## License

The Telerik Document Processing Documentation is licensed under an MIT license. This license applies to the markdown (.md) files in this site **ONLY**, and does not convey, override or modify any existing licenses covering the runtime source and components of Telerik Document Processing. For information about available licenses for the Telerik suites click [here](http://www.telerik.com/purchase/license-agreements).
The Telerik Document Processing Documentation is licensed under an MIT license. This license applies to the markdown (.md) files in this site **ONLY**, and does not convey, override or modify any existing licenses covering the runtime source and components of Telerik Document Processing. For information about available licenses for the Telerik suites click [here](https://www.telerik.com/purchase/license-agreements).

### MIT License

Expand Down
14 changes: 7 additions & 7 deletions _assetsApi/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ article:not(.api-reference)>p:first-child, article:not(.api-reference) h1+p {

# API Reference Overview

The API reference section of the documentation contains a list and descriptions of all public available classes, methods and properties of the Telerik Document Processing product.
The API reference section of the documentation contains a list and descriptions of all publicly available classes, methods, and properties of the Telerik Document Processing product.

> This documentation refers to the latest version of Telerik Document Processing libraries.

Expand All @@ -108,7 +108,7 @@ The following tables list the most used members of the different libraries.
<tr>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Flow.Model.Editing">Telerik.Windows.Documents.Flow.Model.Editing</a></td>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Flow.Model.Editing.RadFlowDocumentEditor.html">RadFlowDocumentEditor</a></td>
<td>Provides methods that allow you to easily modify a RadFlowDocument.</td>
<td>Provides methods that allow you to modify a RadFlowDocument.</td>
</tr>
<tr>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Flow.Model.html">Telerik.Windows.Documents.Flow.Model</a></td>
Expand Down Expand Up @@ -165,12 +165,12 @@ The following tables list the most used members of the different libraries.
<tr>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Fixed.Model.Editing.html">Telerik.Windows.Documents.Fixed.Model.Editing</a></td>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Fixed.Model.Editing.RadFixedDocumentEditor.html">RadFixedDocumentEditor</a></td>
<td>Represents editor that will allow you to modify RadFixedDocument using an automatic layout in a flow-like manner.</td>
<td>Represents an editor that allows you to modify RadFixedDocument using an automatic layout in a flow-like manner.</td>
</tr>
<tr>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Fixed.Model.Editing.html"><span style="font-weight: 400; font-style: normal; text-decoration: none;">Telerik.Windows.Documents.Fixed.Model.Editing</span></a></td>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Fixed.Model.Editing.FixedContentEditor.html">FixedContentEditor</a></td>
<td>Intended to simplify the process of creating and editing the content of an IContentRootElement such as RadFixedPage.It provides methods for working with fixed content.</td>
<td>Simplifies creating and editing the content of an IContentRootElement such as RadFixedPage. It provides methods for working with fixed content.</td>
</tr>
<tr>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Fixed.FormatProviders.Text.html">Telerik.Windows.Documents.Fixed.FormatProviders.Text</a></td>
Expand Down Expand Up @@ -202,7 +202,7 @@ The following tables list the most used members of the different libraries.
<tr>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Spreadsheet.Model.html">Telerik.Windows.Documents.Spreadsheet.Model</a></td>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Spreadsheet.Model.Workbook.html">Workbook</a></td>
<td>The main object that represents the spreadsheet document. It contains collection of Worksheets.</td>
<td>The main object that represents the spreadsheet document. It contains a collection of Worksheets.</td>
</tr>
<tr>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Spreadsheet.Model.html"><span style="font-weight: 400; font-style: normal; text-decoration: none;">Telerik.Windows.Documents.Spreadsheet.Model</span></a></td>
Expand All @@ -212,7 +212,7 @@ The following tables list the most used members of the different libraries.
<tr>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Spreadsheet.Model.html"><span style="font-weight: 400; font-style: normal; text-decoration: none;">Telerik.Windows.Documents.Spreadsheet.Model</span></a></td>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Spreadsheet.Model.Cells.html">Cells</a></td>
<td>Represents a collection of cells inside worksheet.</td>
<td>Represents a collection of cells inside a worksheet.</td>
</tr>
<tr>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.html">Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx</a></td>
Expand Down Expand Up @@ -294,7 +294,7 @@ The following tables list the most used members of the different libraries.
</tr>
<tr>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Zip.CompressedStream.html">CompressedStream</a></td>
<td>Represents stream that allows you to read/write compressed information from/to given input stream.</td>
<td>Represents a stream that allows you to read/write compressed information from/to a given input stream.</td>
</tr>
<tr>
<td><a href="https://docs.telerik.com/devtools/document-processing/api/Telerik.Windows.Zip.Extensions.html">Telerik.Windows.Zip.Extensions</a></td>
Expand Down
16 changes: 8 additions & 8 deletions ai-tools/agent-tools/agent-tools-convert-merge-document-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ position: 4

## ConvertDocumentsAgentTool

The **ConvertDocumentsAgentTool** class provides an agent‑tool wrapper around Telerik’s document conversion engine, enabling automated file conversions within AI‑driven workflows. Typical use cases include converting DOCX → PDF or XLSX → CSV.
The **ConvertDocumentsAgentTool** class provides an agent‑tool wrapper around the Telerik document conversion engine, enabling automated file conversions within AI‑driven workflows. Typical use cases include converting DOCX → PDF or XLSX → CSV.

>note Learn how to integrate the Agent Tools in your application: [Getting Started with DPL Agent Tools]({%slug agent-tools-getting-started%}).

<table>
<tr><th>Tool</th><th style="width:40%;">Signature</th><th>Description</th></tr>
<tr><td>ConvertDocument</td><td><pre>CallToolResult ConvertDocument(
<tr><td><code>ConvertDocument</code></td><td><pre>CallToolResult ConvertDocument(
FileDescriptor sourceFile,
FileDescriptor destinationFile)</pre></td><td>Performs format transformations or direct copies of supported file types.</td></tr>
</table>
Expand All @@ -27,21 +27,21 @@ The **ConvertDocumentsAgentTool** class provides an agent‑tool wrapper around

The tool handles conversions for the following file types:

- Flow documents: .docx, .doc (import only), .rtf, .html
- Fixed documents: .pdf
- Spreadsheet documents: .xlsx, .xls, .xlsm, .csv
- Text documents: .txt
* Flow documents: .docx, .doc (import only), .rtf, .html
* Fixed documents: .pdf
* Spreadsheet documents: .xlsx, .xls, .xlsm, .csv
* Text documents: .txt

>important The Telerik Document Processing libraries provide converting from one document format to another that is **valid and compatible** with the input format. See: [Supported Formats]({%slug introduction%}#supported-formats).

## MergeDocumentsAgentTool

**MergeDocumentsAgentTool** is an agent tool designed to merge multiple documents of varying formats into a single combined output file. It acts as a wrapper around Telerik’s internal MergeDocumentsTool, exposing a tool-enabled method suitable for AI‑driven workflows using Agent Tools.
**MergeDocumentsAgentTool** is an agent tool designed to merge multiple documents of varying formats into a single combined output file. It acts as a wrapper around the Telerik internal `MergeDocumentsTool`, exposing a tool-enabled method suitable for AI‑driven workflows using Agent Tools.
This class supports merging files directly from the file system, avoiding the use of any document import utilities, and maintains a consistent output directory location.

<table>
<tr><th>Tool</th><th style="width:40%;">Signature</th><th>Description</th></tr>
<tr><td>MergeDocuments</td><td><pre>CallToolResult MergeDocuments(
<tr><td><code>MergeDocuments</code></td><td><pre>CallToolResult MergeDocuments(
FileDescriptor[] sourceFilePaths,
FileDescriptor destinationFilePath)</pre></td><td>Merges multiple source files—specified by their disk paths and formats—into a single destination document.</td></tr>
</table>
Expand Down
Loading