update telerik 2026.3.812.462
This commit is contained in:
parent
a3f7a7a4fb
commit
c7d20c6e5c
69 changed files with 417962 additions and 17 deletions
|
|
@ -81,29 +81,53 @@
|
||||||
<Reference Include="Telerik.Licensing.Runtime, Version=1.7.0.0, Culture=neutral, PublicKeyToken=98bb5b04e55c09ef, processorArchitecture=MSIL">
|
<Reference Include="Telerik.Licensing.Runtime, Version=1.7.0.0, Culture=neutral, PublicKeyToken=98bb5b04e55c09ef, processorArchitecture=MSIL">
|
||||||
<HintPath>..\packages\Telerik.Licensing.1.7.0\lib\net462\Telerik.Licensing.Runtime.dll</HintPath>
|
<HintPath>..\packages\Telerik.Licensing.1.7.0\lib\net462\Telerik.Licensing.Runtime.dll</HintPath>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="Telerik.Web.Design, Version=2026.1.225.462, Culture=neutral, PublicKeyToken=121fae78165ba3d4, processorArchitecture=MSIL">
|
<Reference Include="Telerik.Spreadsheet.Web">
|
||||||
<HintPath>..\packages\Telerik.UI.for.AspNet.Ajax.Net462.2026.1.225\lib\net462\Telerik.Web.Design.dll</HintPath>
|
<HintPath>..\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Spreadsheet.Web.dll</HintPath>
|
||||||
|
<Private>True</Private>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="Telerik.Web.Device.Detection, Version=2026.1.225.462, Culture=neutral, PublicKeyToken=121fae78165ba3d4, processorArchitecture=MSIL">
|
<Reference Include="Telerik.Web.Design, Version=2026.3.812.462, Culture=neutral, PublicKeyToken=121fae78165ba3d4, processorArchitecture=MSIL">
|
||||||
<HintPath>..\packages\Telerik.UI.for.AspNet.Ajax.Net462.2026.1.225\lib\net462\Telerik.Web.Device.Detection.dll</HintPath>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
|
<HintPath>..\lib\RCAJAX\2026.3.812.462\Telerik.Web.Design.dll</HintPath>
|
||||||
|
<Private>True</Private>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="Telerik.Web.UI, Version=2026.1.225.462, Culture=neutral, PublicKeyToken=121fae78165ba3d4, processorArchitecture=MSIL">
|
<Reference Include="Telerik.Web.Device.Detection, Version=2026.3.812.462, Culture=neutral, PublicKeyToken=121fae78165ba3d4, processorArchitecture=MSIL">
|
||||||
<HintPath>..\packages\Telerik.UI.for.AspNet.Ajax.Net462.2026.1.225\lib\net462\Telerik.Web.UI.dll</HintPath>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
|
<HintPath>..\lib\RCAJAX\2026.3.812.462\Telerik.Web.Device.Detection.dll</HintPath>
|
||||||
|
<Private>True</Private>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="Telerik.Web.UI.Skins, Version=2026.1.225.462, Culture=neutral, PublicKeyToken=121fae78165ba3d4, processorArchitecture=MSIL">
|
<Reference Include="Telerik.Web.UI, Version=2026.3.812.462, Culture=neutral, PublicKeyToken=121fae78165ba3d4, processorArchitecture=MSIL">
|
||||||
<HintPath>..\packages\Telerik.UI.for.AspNet.Ajax.Net462.2026.1.225\lib\net462\Telerik.Web.UI.Skins.dll</HintPath>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
|
<HintPath>..\lib\RCAJAX\2026.3.812.462\Telerik.Web.UI.dll</HintPath>
|
||||||
|
<Private>True</Private>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="Telerik.Windows.Documents.Core, Version=2026.1.210.462, Culture=neutral, PublicKeyToken=5803cfa389c90ce7, processorArchitecture=MSIL">
|
<Reference Include="Telerik.Web.UI.Skins, Version=2026.3.812.462, Culture=neutral, PublicKeyToken=121fae78165ba3d4, processorArchitecture=MSIL">
|
||||||
<HintPath>..\packages\Telerik.Windows.Documents.Core.2026.1.210\lib\net462\Telerik.Windows.Documents.Core.dll</HintPath>
|
<SpecificVersion>False</SpecificVersion>
|
||||||
|
<HintPath>..\lib\RCAJAX\2026.3.812.462\Telerik.Web.UI.Skins.dll</HintPath>
|
||||||
|
<Private>True</Private>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="Telerik.Windows.Documents.Spreadsheet, Version=2026.1.210.462, Culture=neutral, PublicKeyToken=5803cfa389c90ce7, processorArchitecture=MSIL">
|
<Reference Include="Telerik.Windows.Documents.Core, Version=2026.3.810.462, Culture=neutral, PublicKeyToken=5803cfa389c90ce7, processorArchitecture=MSIL">
|
||||||
<HintPath>..\packages\Telerik.Windows.Documents.Spreadsheet.2026.1.210\lib\net462\Telerik.Windows.Documents.Spreadsheet.dll</HintPath>
|
<HintPath>..\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Windows.Documents.Core.dll</HintPath>
|
||||||
|
<Private>True</Private>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml, Version=2026.1.210.462, Culture=neutral, PublicKeyToken=5803cfa389c90ce7, processorArchitecture=MSIL">
|
<Reference Include="Telerik.Windows.Documents.DrawingML, Version=2026.3.810.462, Culture=neutral, PublicKeyToken=5803cfa389c90ce7, processorArchitecture=MSIL">
|
||||||
<HintPath>..\packages\Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml.2026.1.210\lib\net462\Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml.dll</HintPath>
|
<HintPath>..\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Windows.Documents.DrawingML.dll</HintPath>
|
||||||
|
<Private>True</Private>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="Telerik.Windows.Zip, Version=2026.1.210.462, Culture=neutral, PublicKeyToken=5803cfa389c90ce7, processorArchitecture=MSIL">
|
<Reference Include="Telerik.Windows.Documents.Flow, Version=2026.3.810.462, Culture=neutral, PublicKeyToken=5803cfa389c90ce7, processorArchitecture=MSIL">
|
||||||
<HintPath>..\packages\Telerik.Windows.Zip.2026.1.210\lib\net462\Telerik.Windows.Zip.dll</HintPath>
|
<HintPath>..\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Windows.Documents.Flow.dll</HintPath>
|
||||||
|
<Private>True</Private>
|
||||||
|
</Reference>
|
||||||
|
<Reference Include="Telerik.Windows.Documents.Spreadsheet, Version=2026.3.810.462, Culture=neutral, PublicKeyToken=5803cfa389c90ce7, processorArchitecture=MSIL">
|
||||||
|
<HintPath>..\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Windows.Documents.Spreadsheet.dll</HintPath>
|
||||||
|
<Private>True</Private>
|
||||||
|
</Reference>
|
||||||
|
<Reference Include="Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml, Version=2026.3.810.462, Culture=neutral, PublicKeyToken=5803cfa389c90ce7, processorArchitecture=MSIL">
|
||||||
|
<HintPath>..\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml.dll</HintPath>
|
||||||
|
<Private>True</Private>
|
||||||
|
</Reference>
|
||||||
|
<Reference Include="Telerik.Windows.Zip, Version=2026.3.810.462, Culture=neutral, PublicKeyToken=5803cfa389c90ce7, processorArchitecture=MSIL">
|
||||||
|
<HintPath>..\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Windows.Zip.dll</HintPath>
|
||||||
|
<Private>True</Private>
|
||||||
</Reference>
|
</Reference>
|
||||||
<Reference Include="WindowsBase" />
|
<Reference Include="WindowsBase" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
|
|
@ -1044,7 +1068,7 @@
|
||||||
<SaveServerSettingsInUserFile>True</SaveServerSettingsInUserFile>
|
<SaveServerSettingsInUserFile>True</SaveServerSettingsInUserFile>
|
||||||
</WebProjectProperties>
|
</WebProjectProperties>
|
||||||
</FlavorProperties>
|
</FlavorProperties>
|
||||||
<UserProperties UseAjaxifiedTemplates="True" UseJQuerySupport="True" />
|
<UserProperties UseJQuerySupport="True" UseAjaxifiedTemplates="True" />
|
||||||
</VisualStudio>
|
</VisualStudio>
|
||||||
</ProjectExtensions>
|
</ProjectExtensions>
|
||||||
<Import Project="..\packages\Telerik.Licensing.1.7.0\build\Telerik.Licensing.targets" Condition="Exists('..\packages\Telerik.Licensing.1.7.0\build\Telerik.Licensing.targets')" />
|
<Import Project="..\packages\Telerik.Licensing.1.7.0\build\Telerik.Licensing.targets" Condition="Exists('..\packages\Telerik.Licensing.1.7.0\build\Telerik.Licensing.targets')" />
|
||||||
|
|
|
||||||
187
Safety_Report_2026.09.01_05.48.56.htm
Normal file
187
Safety_Report_2026.09.01_05.48.56.htm
Normal file
|
|
@ -0,0 +1,187 @@
|
||||||
|
|
||||||
|
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||||
|
<head>
|
||||||
|
<title>Telerik UI for ASP.NET AJAX Upgrade Wizard Log</title>
|
||||||
|
<style type="text/css">
|
||||||
|
body {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
top: 0;
|
||||||
|
left: 0;
|
||||||
|
width: 100%;
|
||||||
|
background-color: #fff;
|
||||||
|
font: normal 12px Arial, sans-serif;
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
#header {
|
||||||
|
display: block;
|
||||||
|
margin: 0;
|
||||||
|
padding: 20px;
|
||||||
|
height: 60px;
|
||||||
|
min-width: 600px;
|
||||||
|
background: url('file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Logo.png') no-repeat right 30px top 30px;
|
||||||
|
background-color: #0e0e0e;
|
||||||
|
color: #909090;
|
||||||
|
font: normal 10px Arial, sans-serif;
|
||||||
|
}
|
||||||
|
#header span {
|
||||||
|
display: block;
|
||||||
|
color: #fff;
|
||||||
|
font: normal 22px Arial, sans-serif;
|
||||||
|
}
|
||||||
|
#legend {
|
||||||
|
display: block;
|
||||||
|
height: 20px;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
background-color: #0e0e0e;
|
||||||
|
font: normal 12px Arial, sans-serif;
|
||||||
|
}
|
||||||
|
#legend span {
|
||||||
|
display: block;
|
||||||
|
float: left;
|
||||||
|
height: 18px;
|
||||||
|
margin: 0;
|
||||||
|
padding: 2px 10px 0 10px;
|
||||||
|
background-color: #8e8e8e;
|
||||||
|
font: normal 12px Arial, sans-serif;
|
||||||
|
}
|
||||||
|
table#logTable {
|
||||||
|
border: 1px solid #999;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
table#logTable th, table#logTable td {
|
||||||
|
border: 1px solid #999;
|
||||||
|
padding: 5px 10px;
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
table#logTable th {
|
||||||
|
border: 0;
|
||||||
|
padding: 5px 10px;
|
||||||
|
background-color: #8e8e8e;
|
||||||
|
height: 20px;
|
||||||
|
font: bold 14px Arial, sans-serif;
|
||||||
|
color: #fff;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div>
|
||||||
|
<table id="logTable" cellpadding="0px" cellspacing="0px">
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td colspan="5" style="padding: 0;">
|
||||||
|
<div id="header">
|
||||||
|
Telerik UI for ASP.NET AJAX <span>Upgrade Wizard Log</span>
|
||||||
|
</div>
|
||||||
|
<div id="legend">
|
||||||
|
<span style="background-color: #0e0e0e; color: #fff;">Processed: 12</span>
|
||||||
|
<span style="background-color: green; color: #fff;">Succeeded: 12</span>
|
||||||
|
<span style="background-color: blue; color: #fff;">Info: 0</span>
|
||||||
|
<span style="background-color: gold; color: #fff;">Warnings: 0</span>
|
||||||
|
<span style="background-color: red; color: #fff;">Failed: 0</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th> </th>
|
||||||
|
<th>Project</th>
|
||||||
|
<th>Title</th>
|
||||||
|
<th>Details</th>
|
||||||
|
<th>Result</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<tr>
|
||||||
|
<td><img alt="Success" src="file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Success.gif" /></td>
|
||||||
|
<td>Solution Setup</td>
|
||||||
|
<td>Copied referenced assemblies to solution</td>
|
||||||
|
<td>C:\Program Files (x86)\Progress\Telerik UI for ASP.NET AJAX 2026 Q3\Bin462</td>
|
||||||
|
<td>Success</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><img alt="Success" src="file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Success.gif" /></td>
|
||||||
|
<td>Safety</td>
|
||||||
|
<td>Assembly Reference</td>
|
||||||
|
<td>C:\l\src\Safety\lib\RCAJAX\2026.3.812.462\Telerik.Web.UI.dll</td>
|
||||||
|
<td>Success</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><img alt="Success" src="file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Success.gif" /></td>
|
||||||
|
<td>Safety</td>
|
||||||
|
<td>Assembly Reference</td>
|
||||||
|
<td>C:\l\src\Safety\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Spreadsheet.Web.dll</td>
|
||||||
|
<td>Success</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><img alt="Success" src="file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Success.gif" /></td>
|
||||||
|
<td>Safety</td>
|
||||||
|
<td>Assembly Reference</td>
|
||||||
|
<td>C:\l\src\Safety\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Windows.Documents.Core.dll</td>
|
||||||
|
<td>Success</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><img alt="Success" src="file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Success.gif" /></td>
|
||||||
|
<td>Safety</td>
|
||||||
|
<td>Assembly Reference</td>
|
||||||
|
<td>C:\l\src\Safety\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Windows.Documents.DrawingML.dll</td>
|
||||||
|
<td>Success</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><img alt="Success" src="file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Success.gif" /></td>
|
||||||
|
<td>Safety</td>
|
||||||
|
<td>Assembly Reference</td>
|
||||||
|
<td>C:\l\src\Safety\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Windows.Documents.Flow.dll</td>
|
||||||
|
<td>Success</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><img alt="Success" src="file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Success.gif" /></td>
|
||||||
|
<td>Safety</td>
|
||||||
|
<td>Assembly Reference</td>
|
||||||
|
<td>C:\l\src\Safety\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Windows.Documents.Spreadsheet.dll</td>
|
||||||
|
<td>Success</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><img alt="Success" src="file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Success.gif" /></td>
|
||||||
|
<td>Safety</td>
|
||||||
|
<td>Assembly Reference</td>
|
||||||
|
<td>C:\l\src\Safety\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml.dll</td>
|
||||||
|
<td>Success</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><img alt="Success" src="file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Success.gif" /></td>
|
||||||
|
<td>Safety</td>
|
||||||
|
<td>Assembly Reference</td>
|
||||||
|
<td>C:\l\src\Safety\lib\RCAJAX\2026.3.812.462\AdditionalLibraries\Bin462\Telerik.Windows.Zip.dll</td>
|
||||||
|
<td>Success</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><img alt="Success" src="file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Success.gif" /></td>
|
||||||
|
<td>Safety</td>
|
||||||
|
<td>Assembly Reference</td>
|
||||||
|
<td>C:\l\src\Safety\lib\RCAJAX\2026.3.812.462\Telerik.Web.Design.dll</td>
|
||||||
|
<td>Success</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><img alt="Success" src="file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Success.gif" /></td>
|
||||||
|
<td>Safety</td>
|
||||||
|
<td>Assembly Reference</td>
|
||||||
|
<td>C:\l\src\Safety\lib\RCAJAX\2026.3.812.462\Telerik.Web.Device.Detection.dll</td>
|
||||||
|
<td>Success</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><img alt="Success" src="file:///c:/users/luc.t16luc/appdata/local/microsoft/visualstudio/18.0_0003bce5/extensions/evm0bjel.2lv/Resources/T4Templates/UpgradeLog/Success.gif" /></td>
|
||||||
|
<td>Safety</td>
|
||||||
|
<td>Assembly Reference</td>
|
||||||
|
<td>C:\l\src\Safety\lib\RCAJAX\2026.3.812.462\Telerik.Web.UI.Skins.dll</td>
|
||||||
|
<td>Success</td>
|
||||||
|
</tr>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
Binary file not shown.
Binary file not shown.
|
|
@ -0,0 +1,39 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Documents.AI.AgentTools.Conversion</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Conversion.ConvertDocumentsAgentTool">
|
||||||
|
<summary>
|
||||||
|
Provides functionality to convert or copy supported document files between formats using disk-based operations.
|
||||||
|
</summary>
|
||||||
|
<remarks>Use this tool to handle requests for converting, copying, transforming, or exporting files such as
|
||||||
|
.docx, .doc, .rtf, .pdf, .xlsx, .xls, .xlsm, .csv, .md, or .txt. The tool reads files directly from disk and supports
|
||||||
|
conversion from the .doc format but not exporting to it. For import operations, use specialized import tools
|
||||||
|
instead.</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Conversion.ConvertDocumentsAgentTool.#ctor(Telerik.Documents.AI.Tools.Core.DocumentRepositoryRegistry,System.String)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the ConvertDocumentsAgentTool class with the specified document repository
|
||||||
|
registry and output directory.
|
||||||
|
</summary>
|
||||||
|
<param name="documentRepositoryRegistry">The registry containing document repositories to be used for document conversion operations. Cannot be null.</param>
|
||||||
|
<param name="outputDir">The directory path where converted documents will be saved. Must be a valid, writable directory.</param>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Conversion.MergeDocumentsAgentTool">
|
||||||
|
<summary>
|
||||||
|
Provides functionality to merge multiple document files from the file system into a single combined document.
|
||||||
|
Supports merging .docx, .doc, .rtf, .pdf, .xlsx, .xls, and .csv files.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Conversion.MergeDocumentsAgentTool.#ctor(Telerik.Documents.AI.Tools.Core.DocumentRepositoryRegistry,System.String)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the MergeDocumentsAgentTool class with the specified document repository
|
||||||
|
registry and output directory.
|
||||||
|
</summary>
|
||||||
|
<param name="documentRepositoryRegistry">The registry containing document repositories to be used for merging documents. Cannot be null.</param>
|
||||||
|
<param name="outputDir">The directory path where merged documents will be saved. Must be a valid, writable directory.</param>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,67 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Documents.AI.AgentTools.Fixed</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Fixed.FixedDocumentAgentToolsBase">
|
||||||
|
<summary>
|
||||||
|
Base class for PDF (Fixed) document agent tools that provides document access via a repository.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.AgentTools.Fixed.FixedDocumentAgentToolsBase.Repository">
|
||||||
|
<summary>
|
||||||
|
Gets the fixed document repository.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Fixed.FixedDocumentAgentToolsBase.#ctor(Telerik.Documents.AI.Tools.Fixed.Core.IFixedDocumentRepository)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance with the specified fixed document repository.
|
||||||
|
</summary>
|
||||||
|
<param name="repository">The fixed document repository for document access.</param>
|
||||||
|
<exception cref="T:System.ArgumentNullException">Thrown when repository is null.</exception>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Fixed.FixedDocumentContentAgentTools">
|
||||||
|
<summary>
|
||||||
|
Provides agent tools for creating and manipulating PDF document content.
|
||||||
|
These tools handle content segments including text, images, tables, and document structure.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Fixed.FixedDocumentContentAgentTools.#ctor(Telerik.Documents.AI.Tools.Fixed.Core.IFixedDocumentRepository,System.String)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance with the specified repository.
|
||||||
|
</summary>
|
||||||
|
<param name="repository">The fixed document repository for document access.</param>
|
||||||
|
<param name="imageDirectory">The directory path where images are stored for image segments.</param>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Fixed.FixedDocumentFormAgentTools">
|
||||||
|
<summary>
|
||||||
|
Provides agent tools for working with PDF form fields.
|
||||||
|
These tools handle form field reading and filling operations.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Fixed.FixedDocumentFormAgentTools.#ctor(Telerik.Documents.AI.Tools.Fixed.Core.IFixedDocumentRepository)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance with the specified repository.
|
||||||
|
</summary>
|
||||||
|
<param name="repository">The fixed document repository for document access.</param>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Fixed.FixedDocumentReadAgentTools">
|
||||||
|
<summary>
|
||||||
|
Provides agent tools for reading and inspecting PDF document content.
|
||||||
|
These tools handle text extraction, document description, text search, and bookmark reading.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Fixed.FixedDocumentReadAgentTools.#ctor(Telerik.Documents.AI.Tools.Fixed.Core.IFixedDocumentRepository)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance with the specified repository.
|
||||||
|
</summary>
|
||||||
|
<param name="repository">The fixed document repository for document access.</param>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Fixed.FixedFileManagementAgentTools">
|
||||||
|
<summary>
|
||||||
|
Provides document lifecycle management tools for creating, listing, and exporting fixed documents (PDFs).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,122 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Documents.AI.AgentTools.Spreadsheet</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Spreadsheet.SingleWorkbookRepository">
|
||||||
|
<summary>
|
||||||
|
Repository for single-document analysis scenarios.
|
||||||
|
Wraps an existing Workbook instance and does not support document creation.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SingleWorkbookRepository.#ctor(Telerik.Documents.Spreadsheet.Model.Workbook,System.String)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance wrapping an existing workbook.
|
||||||
|
</summary>
|
||||||
|
<param name="workbook">The workbook to wrap.</param>
|
||||||
|
<param name="documentName">Optional display name for the document.</param>
|
||||||
|
<exception cref="T:System.ArgumentNullException">Thrown when workbook is null.</exception>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.AgentTools.Spreadsheet.SingleWorkbookRepository.SupportsCreation">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.AgentTools.Spreadsheet.SingleWorkbookRepository.SupportsMultipleDocuments">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SingleWorkbookRepository.GetDocument(System.String)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SingleWorkbookRepository.ListDocuments">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SingleWorkbookRepository.CreateDocument(System.String,System.String[])">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SingleWorkbookRepository.Export(System.String,Telerik.Documents.AI.Tools.Core.DocumentFormat,System.IO.Stream)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SingleWorkbookRepository.Import(System.IO.Stream,Telerik.Documents.AI.Tools.Core.DocumentFormat,System.String)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SingleWorkbookRepository.RemoveDocument(System.String)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SingleWorkbookRepository.Clear">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingAgentToolsBase">
|
||||||
|
<summary>
|
||||||
|
Base class for spreadsheet agent tools that provides workbook access via a repository.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingAgentToolsBase.Repository">
|
||||||
|
<summary>
|
||||||
|
Gets the workbook repository.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingAgentToolsBase.#ctor(Telerik.Documents.AI.Tools.Spreadsheet.Core.IWorkbookRepository)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance with the specified workbook repository.
|
||||||
|
</summary>
|
||||||
|
<param name="repository">The workbook repository for document access.</param>
|
||||||
|
<exception cref="T:System.ArgumentNullException">Thrown when repository is null.</exception>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingFileManagementAgentTools">
|
||||||
|
<summary>
|
||||||
|
Provides document lifecycle management tools for creating, listing, and exporting workbooks.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingFormulaAgentTools">
|
||||||
|
<summary>
|
||||||
|
Provides formula and calculation agent tools for spreadsheets.
|
||||||
|
These tools allow formula evaluation and discovery without modifying the document.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingReadAgentTools">
|
||||||
|
<summary>
|
||||||
|
Provides read-only agent tools for querying and analyzing spreadsheet data without modification.
|
||||||
|
These tools are safe for analysis-only scenarios.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingWorksheetAgentTools">
|
||||||
|
<summary>
|
||||||
|
Provides worksheet management agent tools for creating, deleting, and organizing worksheets.
|
||||||
|
These tools modify the workbook structure but not cell content.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingWriteAgentTools">
|
||||||
|
<summary>
|
||||||
|
Provides document editing agent tools for writing data, applying styles, and formatting spreadsheets.
|
||||||
|
These tools modify cell content and formatting in the workbook.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingAnalysisAgentTools">
|
||||||
|
<summary>
|
||||||
|
Provides high-level data analysis tools for spreadsheets using Split-Apply-Combine operations.
|
||||||
|
These tools enable filtering, grouping, and aggregation without requiring formula knowledge.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingAnalysisAgentTools.#ctor(Telerik.Documents.AI.Tools.Spreadsheet.Core.IWorkbookRepository)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance with the specified workbook repository.
|
||||||
|
</summary>
|
||||||
|
<param name="repository">The workbook repository for document access.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingAnalysisAgentTools.DescribeData(System.String,System.String,System.Boolean)">
|
||||||
|
<summary>
|
||||||
|
Gets worksheet structure and column information in a single call.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingAnalysisAgentTools.Aggregate(Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregationType,System.Nullable{System.Int32},System.String,System.Collections.Generic.List{Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.Criterion},Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriteriaLogic,System.Collections.Generic.List{System.Int32},System.Nullable{Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.SortOrder},System.Nullable{System.Int32},Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.HavingCriterion,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
||||||
|
<summary>
|
||||||
|
Aggregates data with optional filtering and grouping.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.AgentTools.Spreadsheet.SpreadProcessingAnalysisAgentTools.GetRows(System.Collections.Generic.List{Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.Criterion},Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriteriaLogic,System.Collections.Generic.List{System.Int32},System.Int32,System.Int32,System.String,System.Nullable{System.Int32},System.String)">
|
||||||
|
<summary>
|
||||||
|
Retrieves rows matching filter criteria.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,242 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Documents.AI.Core</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.AI.Core.Embedding">
|
||||||
|
<summary>
|
||||||
|
Represents a text embedding consisting of the original text and its associated vector representation.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Core.Embedding.#ctor(Telerik.Documents.AI.Core.IFragment,System.Single[])">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the Embedding class with the specified text and vector representation.
|
||||||
|
</summary>
|
||||||
|
<param name="fragment">The source fragment to associate with the embedding. Cannot be null.</param>
|
||||||
|
<param name="vector">The vector representation of the text. Cannot be null.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Core.Embedding.Fragment">
|
||||||
|
<summary>
|
||||||
|
Gets the fragment content associated with this instance.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Core.Embedding.Vector">
|
||||||
|
<summary>
|
||||||
|
Gets the vector representation as an array of single-precision floating-point values.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Core.IContextFragmentsManager">
|
||||||
|
<summary>
|
||||||
|
Provides methods for splitting text into context fragments and joining them.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Core.IContextFragmentsManager.SplitIntoFragments(System.String,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Splits the specified text into fragments suitable for processing, based on the model and encoding.
|
||||||
|
</summary>
|
||||||
|
<param name="text">The input text to split.</param>
|
||||||
|
<param name="maxTokenSizeOfSingleEmbedding">
|
||||||
|
The maximum token size for a single embedding.
|
||||||
|
</param>
|
||||||
|
<returns>An array of text fragments.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Core.IContextRetriever">
|
||||||
|
<summary>
|
||||||
|
Provides methods for retrieving relevant context from embeddings and managing text fragments.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Core.IContextRetriever.GetContextAsync(System.String)">
|
||||||
|
<summary>
|
||||||
|
Gets the text representation of the relevant embeddings for the provided question.
|
||||||
|
</summary>
|
||||||
|
<param name="text">The user prompt to get relevant context for.</param>
|
||||||
|
<returns>The text representations of the relevant embeddings.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Core.IContextRetriever.SetContextAsync(System.String,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Asynchronously splits the specified text into fragments based on the provided embedding token size.
|
||||||
|
</summary>
|
||||||
|
<param name="text">The text to be divided into fragments. Cannot be null.</param>
|
||||||
|
<param name="embeddingTokenSize">The maximum number of tokens allowed in each fragment. Must be a positive integer.</param>
|
||||||
|
<returns>A task that represents the asynchronous operation of fragmenting the text.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Core.IEmbedder">
|
||||||
|
<summary>
|
||||||
|
Defines a contract for generating vector embeddings from a collection of text fragments asynchronously.
|
||||||
|
</summary>
|
||||||
|
<remarks>Implementations of this interface typically interact with machine learning models or external
|
||||||
|
services to produce embeddings. The returned embeddings correspond to the input fragments in order.</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Core.IEmbedder.EmbedAsync(System.Collections.Generic.IList{Telerik.Documents.AI.Core.IFragment})">
|
||||||
|
<summary>
|
||||||
|
Generates embeddings for the specified collection of text fragments asynchronously.
|
||||||
|
</summary>
|
||||||
|
<param name="fragments">A list of text fragments for which to generate embeddings. Each fragment represents a separate input to be
|
||||||
|
embedded. Cannot be null or contain null elements.</param>
|
||||||
|
<returns>A task that represents the asynchronous operation. The task result contains an array of Embedding objects
|
||||||
|
corresponding to each input fragment, in the same order as provided.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Core.IEmbeddingSettings">
|
||||||
|
<summary>
|
||||||
|
Represents configuration settings for generating embeddings using an AI model.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Core.IEmbeddingSettings.ModelMaxInputTokenLimit">
|
||||||
|
<summary>
|
||||||
|
Gets the maximum input token limit the model allows.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Core.IEmbeddingSettings.EmbeddingTokenSize">
|
||||||
|
<summary>
|
||||||
|
Gets the size in tokens of each embedding that will be generated.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Core.IEmbeddingSettings.TokenizationEncoding">
|
||||||
|
<summary>
|
||||||
|
Gets the tokenization encoding.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Core.IEmbeddingSettings.ModelId">
|
||||||
|
<summary>
|
||||||
|
Gets the ID of the model.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Core.IFragment">
|
||||||
|
<summary>
|
||||||
|
Defines a fragment which can be converted to text representations suitable for context or embedding scenarios.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Core.IFragment.ToContextText">
|
||||||
|
<summary>
|
||||||
|
Returns a string representation of the object's context suitable for display or logging.
|
||||||
|
</summary>
|
||||||
|
<returns>A string containing text suitable for adding to an LLM context.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Core.IFragment.ToEmbeddingText">
|
||||||
|
<summary>
|
||||||
|
Converts the current object to a plain text representation suitable for use in embedding models.
|
||||||
|
</summary>
|
||||||
|
<returns>A string containing the embedding-compatible text representation of the object.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Core.IFragments">
|
||||||
|
<summary>
|
||||||
|
Provides access to a collection of string fragments.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Core.IFragments.Fragments">
|
||||||
|
<summary>
|
||||||
|
Gets the collection of fragments associated with the current instance.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Core.ISimilarityCalculator">
|
||||||
|
<summary>
|
||||||
|
Defines methods for calculating similarity scores between a query and a set of text fragments, enabling
|
||||||
|
retrieval of the most relevant fragments based on semantic similarity.
|
||||||
|
</summary>
|
||||||
|
<remarks>Implementations of this interface typically use vector embeddings to measure semantic
|
||||||
|
similarity between the input question and provided fragments. Methods return an array of similarity scores,
|
||||||
|
ordered by relevance, which can be used to identify the closest matches. This interface is intended for use in
|
||||||
|
scenarios such as search, question answering, or recommendation systems where ranking by semantic similarity is
|
||||||
|
required.</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Core.ISimilarityCalculator.CalculateScores(System.String,System.Collections.Generic.IList{Telerik.Documents.AI.Core.Embedding})">
|
||||||
|
<param name="prompt">The input prompt to compare against the provided fragments. Cannot be null.</param>
|
||||||
|
<param name="embeddings">A list of embeddings representing the fragments to be compared. Cannot be null or empty.</param>
|
||||||
|
<returns>A task that represents the asynchronous operation. The task result contains an array of SimilarityScore objects,
|
||||||
|
each representing a fragment and its similarity score. The array will be empty if no fragments are similar.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Core.ISupportJsonEmbeddings">
|
||||||
|
<summary>
|
||||||
|
Defines behavior for settings working with embedding of json.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Core.ISupportJsonEmbeddings.ProduceJsonFormattedContext">
|
||||||
|
<summary>
|
||||||
|
Determines whether the context sent to the model is in JSON or plain text format, if json format is applicable.
|
||||||
|
</summary>
|
||||||
|
<remarks>Plain text might consume more tokens but should lead to better results when asking the LLM.</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Core.ISupportJsonEmbeddings.TotalContextTokenLimit">
|
||||||
|
<summary>
|
||||||
|
Gets the maximum number of tokens allowed in the context to be sent to the model.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Core.ISupportPlainTextEmbeddings">
|
||||||
|
<summary>
|
||||||
|
Defines behavior for settings working with embedding of plain text.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Core.ISupportPlainTextEmbeddings.MaxNumberOfEmbeddingsIncludedInContext">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the maximum number of embeddings to be sent to the model.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Core.ITokensCounter">
|
||||||
|
<summary>
|
||||||
|
Defines a contract for counting tokens in a given input.
|
||||||
|
</summary>
|
||||||
|
<remarks>Implementations of this interface are responsible for analyzing input data and determining
|
||||||
|
the number of tokens it contains. The definition of a "token" may vary depending on the specific implementation
|
||||||
|
(e.g., words, characters, or other units of text).</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Core.ITokensCounter.Count(System.String)">
|
||||||
|
<summary>
|
||||||
|
Counts the number of tokens in the specified input.
|
||||||
|
</summary>
|
||||||
|
<param name="input">The input data to analyze.</param>
|
||||||
|
<returns>The number of tokens in the input.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Core.SimilarityScore`1">
|
||||||
|
<summary>
|
||||||
|
Represents a score indicating the similarity of an item to a reference point.
|
||||||
|
</summary>
|
||||||
|
<remarks>This structure is used to encapsulate the similarity score of an item, along with the item
|
||||||
|
itself. It is particularly useful in scenarios where items need to be ranked or sorted based on their similarity
|
||||||
|
to a reference point. The <see cref="F:Telerik.Documents.AI.Core.SimilarityScore`1.Comparer"/> ensures that items with the same similarity score are
|
||||||
|
distinguished by a unique index, which is useful for operations that require distinct results.</remarks>
|
||||||
|
<typeparam name="T">The type of the item being compared.</typeparam>
|
||||||
|
<param name="similarity">The similarity score indicating how closely the item matches the comparison criteria. Higher values represent
|
||||||
|
greater similarity.</param>
|
||||||
|
<param name="item">The item of type T that is associated with the similarity score.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Core.SimilarityScore`1.#ctor(System.Single,`0)">
|
||||||
|
<summary>
|
||||||
|
Represents a score indicating the similarity of an item to a reference point.
|
||||||
|
</summary>
|
||||||
|
<remarks>This structure is used to encapsulate the similarity score of an item, along with the item
|
||||||
|
itself. It is particularly useful in scenarios where items need to be ranked or sorted based on their similarity
|
||||||
|
to a reference point. The <see cref="F:Telerik.Documents.AI.Core.SimilarityScore`1.Comparer"/> ensures that items with the same similarity score are
|
||||||
|
distinguished by a unique index, which is useful for operations that require distinct results.</remarks>
|
||||||
|
<typeparam name="T">The type of the item being compared.</typeparam>
|
||||||
|
<param name="similarity">The similarity score indicating how closely the item matches the comparison criteria. Higher values represent
|
||||||
|
greater similarity.</param>
|
||||||
|
<param name="item">The item of type T that is associated with the similarity score.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Core.SimilarityScore`1.Similarity">
|
||||||
|
<summary>
|
||||||
|
Gets the similarity score between two compared entities.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Core.SimilarityScore`1.Item">
|
||||||
|
<summary>
|
||||||
|
Gets the item of type <typeparamref name="T"/>.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Core.SimilarityScore`1.Comparer">
|
||||||
|
<summary>
|
||||||
|
Gets a comparer that orders <see cref="T:Telerik.Documents.AI.Core.SimilarityScore`1"/> instances by descending similarity, using the
|
||||||
|
unique index as a tiebreaker.
|
||||||
|
</summary>
|
||||||
|
<remarks>This comparer is useful for sorting collections of <see cref="T:Telerik.Documents.AI.Core.SimilarityScore`1"/>
|
||||||
|
so that items with higher similarity values appear first. If two items have the same similarity, the one
|
||||||
|
with the lower unique index is considered less than the other.</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Core.SimilarityScore`1.ToString">
|
||||||
|
<summary>
|
||||||
|
Returns a string that represents the current object, including its similarity value and item.
|
||||||
|
</summary>
|
||||||
|
<returns>A string containing the similarity value and item of this instance, formatted for readability.</returns>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,141 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Documents.AI.RAG</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.AI.RAG.DefaultContextFragmentsManager">
|
||||||
|
<summary>
|
||||||
|
Default implementation of <see cref="T:Telerik.Documents.AI.Core.IContextFragmentsManager"/> that splits text into
|
||||||
|
token sized fragments respecting a maximum token limit per fragment.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.RAG.DefaultContextFragmentsManager.SplitIntoFragments(System.String,System.Int32)">
|
||||||
|
<inheritdoc />
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.RAG.DefaultContextRetriever">
|
||||||
|
<summary>
|
||||||
|
Provides a default implementation for retrieving relevant context fragments based on semantic similarity to a
|
||||||
|
given question.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.RAG.DefaultContextRetriever.ContextFragmentsManager">
|
||||||
|
<summary>
|
||||||
|
Gets the manager responsible for handling context fragments within the current instance.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.RAG.DefaultContextRetriever.#ctor(Telerik.Documents.AI.Core.IContextFragmentsManager,Telerik.Documents.AI.Core.IEmbedder,Telerik.Documents.AI.Core.ISimilarityCalculator,Telerik.Documents.AI.Core.ITokensCounter,Telerik.Documents.AI.Core.IEmbeddingSettings)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the DefaultContextRetriever class with the specified context fragments
|
||||||
|
manager, embedder, similarity calculator, tokens counter, and embedding settings.
|
||||||
|
</summary>
|
||||||
|
<param name="contextFragmentsManager">The manager responsible for handling context fragments used in retrieval operations. Cannot be null.</param>
|
||||||
|
<param name="embedder">The component used to generate embeddings for context fragments. Cannot be null.</param>
|
||||||
|
<param name="similarityCalculator">The calculator used to determine similarity between embeddings. Cannot be null.</param>
|
||||||
|
<param name="tokensCounter">The service used to count tokens in context fragments and embeddings. Cannot be null.</param>
|
||||||
|
<param name="settings">The settings that configure embedding parameters, such as the maximum number of embeddings, embedding token
|
||||||
|
size, and model input token limit. Cannot be null.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.RAG.DefaultContextRetriever.GetContextAsync(System.String)">
|
||||||
|
<summary>
|
||||||
|
Gets the text representation of the relevant embeddings for the provided question.
|
||||||
|
</summary>
|
||||||
|
<param name="text">The question text to find relevant context for. Cannot be null.</param>
|
||||||
|
<returns>The text representation of the relevant embeddings.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.RAG.DefaultContextRetriever.SetContextAsync(System.String,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Asynchronously splits the specified text into fragments based on the provided embedding token size.
|
||||||
|
</summary>
|
||||||
|
<param name="text">The text to be divided into fragments. Cannot be null.</param>
|
||||||
|
<param name="embeddingTokenSize">The maximum number of tokens allowed in each fragment. Must be a positive integer.</param>
|
||||||
|
<returns>A task that represents the asynchronous operation of fragmenting the text.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.RAG.DefaultFragments">
|
||||||
|
<summary>
|
||||||
|
Provides a default implementation of the <see cref="T:Telerik.Documents.AI.Core.IFragments"/> interface that stores a collection of
|
||||||
|
fragments.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.RAG.DefaultFragments.#ctor(Telerik.Documents.AI.Core.IFragment[])">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the DefaultFragments class with the specified fragments.
|
||||||
|
</summary>
|
||||||
|
<param name="strings">An array of fragments to be used. Cannot be null.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.RAG.DefaultFragments.Fragments">
|
||||||
|
<summary>
|
||||||
|
Gets the collection of fragments that compose the complete content.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.RAG.DefaultSimilarityCalculator">
|
||||||
|
<summary>
|
||||||
|
Provides a default implementation of the ISimilarityCalculator interface for finding the most similar text
|
||||||
|
fragments to a given question using embeddings.
|
||||||
|
</summary>
|
||||||
|
<remarks>This class uses an IEmbedder to generate embeddings for input text and compares them to
|
||||||
|
provided fragments to determine similarity.</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.RAG.DefaultSimilarityCalculator.#ctor(Telerik.Documents.AI.Core.IEmbedder)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the DefaultSimilarityCalculator class using the specified embedder.
|
||||||
|
</summary>
|
||||||
|
<param name="embedder">The embedder used to generate vector representations for similarity calculations. Cannot be null.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.RAG.DefaultSimilarityCalculator.CalculateScores(System.String,System.Collections.Generic.IList{Telerik.Documents.AI.Core.Embedding})">
|
||||||
|
<summary>
|
||||||
|
Finds the most similar text fragments to the specified question and returns their similarity scores.
|
||||||
|
</summary>
|
||||||
|
<remarks>The method uses the current embedding model to compute similarity between the
|
||||||
|
question and each fragment. If the specified limit exceeds the number of fragments, all fragments are
|
||||||
|
considered. The results are ordered by descending similarity score.</remarks>
|
||||||
|
<param name="prompt">The input question to compare against the provided fragments. Cannot be null, empty, or whitespace.</param>
|
||||||
|
<param name="embeddings">An array of embeddings representing the text fragments to search. Cannot be null or empty.</param>
|
||||||
|
<returns>An array of similarity scores, each containing a fragment and its similarity to the question. Returns an empty array on error conditions.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.RAG.DefaultTokensCounter">
|
||||||
|
<summary>
|
||||||
|
Provides functionality to count tokens in a given input, such as words or other units of text.
|
||||||
|
</summary>
|
||||||
|
<remarks>This class implements the <see cref="T:Telerik.Documents.AI.Core.ITokensCounter"/> interface, allowing for token counting
|
||||||
|
operations. The specific behavior and definition of a "token" depend on the implementation of the
|
||||||
|
interface.</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.RAG.DefaultTokensCounter.#ctor(Telerik.Documents.AI.Core.IEmbeddingSettings)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.AI.RAG.DefaultTokensCounter"/> class with the specified embedding settings.
|
||||||
|
</summary>
|
||||||
|
<remarks>The <paramref name="settings"/> parameter is used to configure the tokenizer encoding
|
||||||
|
based on the specified model ID and tokenization encoding. Ensure that the <see cref="T:Telerik.Documents.AI.Core.IEmbeddingSettings"/>
|
||||||
|
object is properly configured before passing it to this constructor.</remarks>
|
||||||
|
<param name="settings">The embedding settings that define the model ID and tokenization encoding to be used.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.RAG.DefaultTokensCounter.Count(System.String)">
|
||||||
|
<summary>
|
||||||
|
Counts the number of tokens in the specified input string.
|
||||||
|
</summary>
|
||||||
|
<param name="input">The input string to analyze. Cannot be null.</param>
|
||||||
|
<returns>The total number of tokens found in the input string.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.RAG.EmbeddingSimilarityHelper">
|
||||||
|
<summary>
|
||||||
|
Provides helper methods for calculating similarity scores between an already embedded question vector
|
||||||
|
and a collection of fragment <see cref="T:Telerik.Documents.AI.Core.Embedding"/> instances.
|
||||||
|
</summary>
|
||||||
|
<remarks>
|
||||||
|
This helper is intentionally static and independent from any concrete <see cref="T:Telerik.Documents.AI.Core.IEmbedder"/> implementation
|
||||||
|
so that external components (e.g. test applications using different embedding providers such as Ollama)
|
||||||
|
can reuse the core similarity computation logic without duplicating code.
|
||||||
|
</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.RAG.EmbeddingSimilarityHelper.FindClosestWithScore(System.Single[],System.Collections.Generic.IList{Telerik.Documents.AI.Core.Embedding})">
|
||||||
|
<summary>
|
||||||
|
Calculates cosine-similarity scores between a question embedding vector and fragment embeddings,
|
||||||
|
returning the top results ordered descending by similarity.
|
||||||
|
</summary>
|
||||||
|
<param name="questionVector">The embedding vector of the question.</param>
|
||||||
|
<param name="embeddings">The fragment embeddings to compare against.</param>
|
||||||
|
<returns>Array of <see cref="T:Telerik.Documents.AI.Core.SimilarityScore`1"/> where T is IFragment.</returns>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,8 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Documents.AI.Tools.Conversion.Core</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,570 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Documents.AI.Tools.Core</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.AgentToolBase">
|
||||||
|
<summary>
|
||||||
|
Provides a base class for defining agent tools that can be automatically discovered and exposed as AITool
|
||||||
|
instances.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.AgentToolBase.#ctor">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the AgentToolBase class.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.AgentToolBase.ExecuteWithValidation(System.Func{Telerik.Documents.AI.Tools.Core.CallToolResult})">
|
||||||
|
<summary>
|
||||||
|
Executes the tool logic with license validation. This is the required pattern for all tool implementations.
|
||||||
|
License validation is performed before executing the tool logic, unless already validated via GetTools wrapper.
|
||||||
|
</summary>
|
||||||
|
<param name="toolLogic">The tool logic to execute after license validation.</param>
|
||||||
|
<returns>A <see cref="T:Telerik.Documents.AI.Tools.Core.CallToolResult"/> with the tool result or license error.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.AgentToolBase.GetTools">
|
||||||
|
<summary>
|
||||||
|
Gets all tools as AITool instances, automatically discovering wrapper methods.
|
||||||
|
License validation is performed on every tool invocation.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.AgentToolBase.LicenseValidatedAIFunction">
|
||||||
|
<summary>
|
||||||
|
Wrapper AIFunction that validates license before invoking the original function.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.CallToolResult">
|
||||||
|
<summary>
|
||||||
|
Legacy tool result structure.
|
||||||
|
For new code, use strongly-typed results from Messages.Tools namespace.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.CallToolResult.IsError">
|
||||||
|
<summary>
|
||||||
|
Gets or sets a value indicating whether the tool execution encountered an error.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.CallToolResult.Message">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the result message.
|
||||||
|
Can contain plain text, JSON, SVG, or other content.
|
||||||
|
For new code, use StructuredResult instead.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.DocumentFormat">
|
||||||
|
<summary>
|
||||||
|
Defines the supported document formats for import/export operations.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentFormat.XLSX">
|
||||||
|
<summary>
|
||||||
|
Excel Open XML Spreadsheet format (.xlsx).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentFormat.CSV">
|
||||||
|
<summary>
|
||||||
|
Comma-Separated Values format (.csv).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentFormat.XLS">
|
||||||
|
<summary>
|
||||||
|
Excel 97-2003 format (.xls).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentFormat.XLSM">
|
||||||
|
<summary>
|
||||||
|
Excel macro-enabled workbook file format (.xlsm).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentFormat.DOCX">
|
||||||
|
<summary>
|
||||||
|
Word Open XML Document format (.docx).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentFormat.DOC">
|
||||||
|
<summary>
|
||||||
|
Word 97-2003 format (.doc).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentFormat.RTF">
|
||||||
|
<summary>
|
||||||
|
Rich Text Format (.rtf).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentFormat.HTML">
|
||||||
|
<summary>
|
||||||
|
HyperText Markup Language (.html).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentFormat.MD">
|
||||||
|
<summary>
|
||||||
|
Markdown format (.md).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentFormat.TXT">
|
||||||
|
<summary>
|
||||||
|
Plain text format (.txt).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentFormat.PDF">
|
||||||
|
<summary>
|
||||||
|
Portable Document Format (.pdf).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentFormat.PNG">
|
||||||
|
<summary>
|
||||||
|
Portable Network Graphics image format (.png).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.DocumentInfo">
|
||||||
|
<summary>
|
||||||
|
Contains metadata about a document managed by a document repository.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.DocumentInfo.Id">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the unique identifier for the document.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.DocumentInfo.Name">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the display name of the document.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.DocumentInfo.Format">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the format of the document.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.DocumentProcessingOptions">
|
||||||
|
<summary>
|
||||||
|
Configuration options for document processing repositories.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.DocumentProcessingOptions.ImportTimeout">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the timeout for document import operations.
|
||||||
|
Set to null to allow unlimited time (not recommended for production).
|
||||||
|
For security against DDoS attacks, explicitly choose a reasonable timeout value.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.DocumentRepositoryRegistry">
|
||||||
|
<summary>
|
||||||
|
Provides a registry for associating document types with their corresponding document repositories.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.DocumentRepositoryRegistry.RegisterRepository(Telerik.Documents.AI.Tools.Core.DocumentType,Telerik.Documents.AI.Tools.Core.IDocumentRepository)">
|
||||||
|
<summary>
|
||||||
|
Registers the specified document repository for the given document type.
|
||||||
|
</summary>
|
||||||
|
<param name="documentType">The type of document for which the repository is being registered.</param>
|
||||||
|
<param name="repository">The repository instance to associate with the specified document type. Cannot be null.</param>
|
||||||
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="repository"/> is null.</exception>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.DocumentRepositoryRegistry.TryGetRepository(Telerik.Documents.AI.Tools.Core.DocumentType,Telerik.Documents.AI.Tools.Core.IDocumentRepository@)">
|
||||||
|
<summary>
|
||||||
|
Attempts to retrieve the repository associated with the specified document type.
|
||||||
|
</summary>
|
||||||
|
<remarks>This method does not throw an exception if the repository is not found. Use the
|
||||||
|
returned Boolean value to determine whether the repository was successfully retrieved.</remarks>
|
||||||
|
<param name="documentType">The type of document for which to retrieve the repository.</param>
|
||||||
|
<param name="repository">When this method returns, contains the repository associated with the specified document type, if found;
|
||||||
|
otherwise, <see langword="null"/>. This parameter is passed uninitialized.</param>
|
||||||
|
<returns><see langword="true"/> if a repository for the specified document type was found; otherwise, <see
|
||||||
|
langword="false"/>.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.DocumentType">
|
||||||
|
<summary>
|
||||||
|
Specifies the type of Document Processing document.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentType.Workbook">
|
||||||
|
<summary>
|
||||||
|
Represents a collection of worksheets and related data within a spreadsheet file. The main document class of the Telerik SpreadProcessing library.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentType.FlowDocument">
|
||||||
|
<summary>
|
||||||
|
Represents a flow content document that supports rich formatting, layout, and editing features. The main document class of the Telerik WordsProcessing library.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.DocumentType.FixedDocument">
|
||||||
|
<summary>
|
||||||
|
Represents a fixed-layout document that can be paginated and viewed, typically used for print-ready content
|
||||||
|
or precise document rendering. The main document class of the Telerik PdfProcessing library.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.FileDescriptor">
|
||||||
|
<summary>
|
||||||
|
Describes a document file with its path and format for processing operations
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.FileDescriptor.FilePath">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the path to the document file to be processed.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.FileDescriptor.Format">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the format of the document file.
|
||||||
|
</summary>
|
||||||
|
<remarks>Supported formats include Word (DOC, DOCX, RTF, HTML, MD, TXT), Spreadsheet (XLS, XLSX,
|
||||||
|
CSV, TXT), and PDF. The selected format determines how the document is processed and saved.</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.FileManagementTools">
|
||||||
|
<summary>
|
||||||
|
Provides document lifecycle management tools for creating, listing, and exporting documents.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.IDocumentRepository">
|
||||||
|
<summary>
|
||||||
|
Defines a contract for managing, importing, exporting, and retrieving documents of a specific type within a
|
||||||
|
repository.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.IDocumentRepository.DocumentType">
|
||||||
|
<summary>
|
||||||
|
Gets the type of the document represented by this instance.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.IDocumentRepository.SupportsCreation">
|
||||||
|
<summary>
|
||||||
|
Gets a value indicating whether this repository supports creating new documents.
|
||||||
|
Single-document repositories typically return false.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.IDocumentRepository.SupportsMultipleDocuments">
|
||||||
|
<summary>
|
||||||
|
Gets a value indicating whether this repository supports managing multiple documents.
|
||||||
|
Single-document repositories return false.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.IDocumentRepository.ListDocuments">
|
||||||
|
<summary>
|
||||||
|
Lists all documents currently managed by this repository.
|
||||||
|
</summary>
|
||||||
|
<returns>Collection of document metadata.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.IDocumentRepository.Export(System.String,Telerik.Documents.AI.Tools.Core.DocumentFormat,System.IO.Stream)">
|
||||||
|
<summary>
|
||||||
|
Exports a document to a byte array in the specified format.
|
||||||
|
</summary>
|
||||||
|
<param name="documentId">
|
||||||
|
The document identifier to export. If null, exports the default/current document.
|
||||||
|
</param>
|
||||||
|
<param name="format">The target format for export.</param>
|
||||||
|
<param name="destinationStream">The stream to which the document will be exported.</param>
|
||||||
|
<returns>The document content as a byte array.</returns>
|
||||||
|
<exception cref="T:System.NotSupportedException">
|
||||||
|
Thrown when the specified format is not supported.
|
||||||
|
</exception>
|
||||||
|
<exception cref="T:System.Collections.Generic.KeyNotFoundException">
|
||||||
|
Thrown when the specified document ID does not exist.
|
||||||
|
</exception>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.IDocumentRepository.Import(System.IO.Stream,Telerik.Documents.AI.Tools.Core.DocumentFormat,System.String)">
|
||||||
|
<summary>
|
||||||
|
Imports a document from a byte array and adds it to the repository.
|
||||||
|
</summary>
|
||||||
|
<param name="data">The document content as a byte array.</param>
|
||||||
|
<param name="format">The format of the document being imported.</param>
|
||||||
|
<param name="documentName">Optional name for the imported document.</param>
|
||||||
|
<returns>The document ID assigned to the imported document.</returns>
|
||||||
|
<exception cref="T:System.NotSupportedException">
|
||||||
|
Thrown when the repository does not support creation or the format is not supported.
|
||||||
|
</exception>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.IDocumentRepository.GetDocumentAsObject(System.String)">
|
||||||
|
<summary>
|
||||||
|
Gets a document by its identifier.
|
||||||
|
</summary>
|
||||||
|
<param name="documentId">
|
||||||
|
The document identifier. If null, returns the default/current document.
|
||||||
|
In single-document mode, this parameter is ignored.
|
||||||
|
</param>
|
||||||
|
<returns>The requested document instance.</returns>
|
||||||
|
<exception cref="T:System.Collections.Generic.KeyNotFoundException">
|
||||||
|
Thrown when the specified document ID does not exist.
|
||||||
|
</exception>
|
||||||
|
<exception cref="T:System.InvalidOperationException">
|
||||||
|
Thrown when no documents are available and documentId is null.
|
||||||
|
</exception>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.IDocumentRepository.CreateDocument(System.String,System.String[])">
|
||||||
|
<summary>
|
||||||
|
Creates a document using the specified document identifier and arguments.
|
||||||
|
</summary>
|
||||||
|
<param name="documentId">The unique identifier for the document to be created. Cannot be null or empty.</param>
|
||||||
|
<param name="args">An array of arguments used to populate or configure the document. Cannot be null.</param>
|
||||||
|
<returns>A string containing the contents of the created document.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.IDocumentRepository.MergeAndExport(System.String[],System.IO.Stream,Telerik.Documents.AI.Tools.Core.DocumentFormat)">
|
||||||
|
<summary>
|
||||||
|
Merges the specified source documents and exports the combined result to the provided stream in the
|
||||||
|
specified format.
|
||||||
|
</summary>
|
||||||
|
<param name="sourceFileIds">An array of identifiers for the source documents to merge. The order of identifiers determines the order in
|
||||||
|
which documents are merged. Cannot be null or empty.</param>
|
||||||
|
<param name="stream">The stream to which the merged document will be written. Must be writable and remain open for the duration
|
||||||
|
of the operation.</param>
|
||||||
|
<param name="exportFormat">The format in which to export the merged document.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.IDocumentRepository.RemoveDocument(System.String)">
|
||||||
|
<summary>
|
||||||
|
Removes a document from the repository.
|
||||||
|
</summary>
|
||||||
|
<param name="documentId">The identifier of the document to remove.</param>
|
||||||
|
<returns>True if the document was removed; false if not found.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.IDocumentRepository.Clear">
|
||||||
|
<summary>
|
||||||
|
Removes all documents from the repository.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.IDocumentRepository`1">
|
||||||
|
<summary>
|
||||||
|
Provides a unified interface for managing documents of a specific type.
|
||||||
|
Implementations can support single-document or multi-document scenarios.
|
||||||
|
</summary>
|
||||||
|
<typeparam name="TDocument">The type of document managed by this repository.</typeparam>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.IDocumentRepository`1.GetDocument(System.String)">
|
||||||
|
<summary>
|
||||||
|
Gets a document by its identifier.
|
||||||
|
</summary>
|
||||||
|
<param name="documentId">
|
||||||
|
The document identifier. If null, returns the default/current document.
|
||||||
|
In single-document mode, this parameter is ignored.
|
||||||
|
</param>
|
||||||
|
<returns>The requested document instance.</returns>
|
||||||
|
<exception cref="T:System.Collections.Generic.KeyNotFoundException">
|
||||||
|
Thrown when the specified document ID does not exist.
|
||||||
|
</exception>
|
||||||
|
<exception cref="T:System.InvalidOperationException">
|
||||||
|
Thrown when no documents are available and documentId is null.
|
||||||
|
</exception>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1">
|
||||||
|
<summary>
|
||||||
|
Base class for in-memory document repositories that manage multiple documents.
|
||||||
|
Provides common functionality for document storage, ID management, and metadata tracking.
|
||||||
|
</summary>
|
||||||
|
<typeparam name="TDocument">The type of document managed by this repository.</typeparam>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.documents">
|
||||||
|
<summary>
|
||||||
|
Storage for documents keyed by document ID.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.documentInfos">
|
||||||
|
<summary>
|
||||||
|
Storage for document metadata keyed by document ID.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.currentDocumentId">
|
||||||
|
<summary>
|
||||||
|
The ID of the currently active document.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.importTimeout">
|
||||||
|
<summary>
|
||||||
|
The timeout for import operations, or null for no timeout.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.#ctor(System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance with no documents.
|
||||||
|
</summary>
|
||||||
|
<param name="importTimeout">Timeout for import operations, or null to allow unlimited time.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.SupportsCreation">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.SupportsMultipleDocuments">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.DocumentType">
|
||||||
|
<summary>
|
||||||
|
Gets the document type managed by this repository.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.DefaultFormat">
|
||||||
|
<summary>
|
||||||
|
Gets the default format for documents created by this repository.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.DefaultNewDocumentBaseName">
|
||||||
|
<summary>
|
||||||
|
Gets the default base name for newly created documents.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.GetDocument(System.String)">
|
||||||
|
<summary>
|
||||||
|
Gets a document by its ID, or the current document if no ID is specified.
|
||||||
|
</summary>
|
||||||
|
<param name="documentId">The document ID, or null to get the current document.</param>
|
||||||
|
<returns>The requested document.</returns>
|
||||||
|
<exception cref="T:System.InvalidOperationException">No document ID specified and no current document is set.</exception>
|
||||||
|
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The specified document ID was not found.</exception>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.GetDocumentAsObject(System.String)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.ListDocuments">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.ResolveDocumentId(System.String,System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Resolves and validates a document ID according to Option 3 rules:
|
||||||
|
- If null/empty, generates a unique ID using the provided base name
|
||||||
|
- If provided and already exists, throws ArgumentException
|
||||||
|
- If provided and unique, returns it as-is
|
||||||
|
</summary>
|
||||||
|
<param name="documentId">The document ID to validate, or null/empty for auto-generation.</param>
|
||||||
|
<param name="defaultBaseName">The base name to use when generating a new ID.</param>
|
||||||
|
<param name="paramName">The parameter name for exception messages.</param>
|
||||||
|
<returns>The validated or generated document ID.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.StoreDocument(System.String,`0,System.String,Telerik.Documents.AI.Tools.Core.DocumentFormat)">
|
||||||
|
<summary>
|
||||||
|
Stores a document and its metadata in the repository.
|
||||||
|
</summary>
|
||||||
|
<param name="documentId">The document ID.</param>
|
||||||
|
<param name="document">The document to store.</param>
|
||||||
|
<param name="name">The display name for the document.</param>
|
||||||
|
<param name="format">The document format.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.GenerateUniqueId(System.String)">
|
||||||
|
<summary>
|
||||||
|
Generates a unique document ID, appending a numeric suffix if needed.
|
||||||
|
</summary>
|
||||||
|
<param name="baseName">The base name for the ID.</param>
|
||||||
|
<returns>A unique document ID.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.RemoveDocument(System.String)">
|
||||||
|
<summary>
|
||||||
|
Removes a document from the repository.
|
||||||
|
</summary>
|
||||||
|
<param name="documentId">The identifier of the document to remove.</param>
|
||||||
|
<returns>True if the document was removed; false if not found.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.InMemoryDocumentRepositoryBase`1.Clear">
|
||||||
|
<summary>
|
||||||
|
Removes all documents from the repository.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.ISupportPdfExport">
|
||||||
|
<summary>
|
||||||
|
Defines a contract for exporting documents to PDF format.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.ISupportPdfExport.ExportToPdf(System.String,System.IO.Stream)">
|
||||||
|
<summary>
|
||||||
|
Exports the specified document to PDF format and writes the result to the provided stream.
|
||||||
|
</summary>
|
||||||
|
<param name="documentId">The unique identifier of the document to export. Cannot be null or empty.</param>
|
||||||
|
<param name="destinationStream">The stream to which the generated PDF will be written. Must be writable and remain open for the duration of
|
||||||
|
the operation.</param>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.License.LicenseException">
|
||||||
|
<summary>
|
||||||
|
Represents errors that occur during license validation for Telerik Document Processing libraries.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.License.LicenseException.#ctor(System.String)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.AI.Tools.Core.License.LicenseException"/> class with a specified error message.
|
||||||
|
</summary>
|
||||||
|
<param name="message">The message that describes the license validation error.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.License.LicenseException.#ctor(System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.AI.Tools.Core.License.LicenseException"/> class with a specified error message.
|
||||||
|
</summary>
|
||||||
|
<param name="message">The message that describes the license validation error.</param>
|
||||||
|
<param name="log">The log content providing details about the license validation process.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.License.LicenseException.Log">
|
||||||
|
<summary>
|
||||||
|
Gets the log content as a string, providing a record of events or messages generated by the application.
|
||||||
|
</summary>
|
||||||
|
<remarks>The log is updated in real-time and can be used for monitoring application behavior
|
||||||
|
or debugging purposes.</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.License.LicenseValidator.ValidateAndLog">
|
||||||
|
<summary>
|
||||||
|
Validates the Telerik license during tool initialization.
|
||||||
|
Logs a warning if license is invalid but does not throw.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.License.LicenseValidator.ValidateAndGetError">
|
||||||
|
<summary>
|
||||||
|
Validates the Telerik license before tool execution and returns the result.
|
||||||
|
Returns null if valid, or a CallToolResult error if invalid.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.PathValidator">
|
||||||
|
<summary>
|
||||||
|
Provides validation utilities for output file paths.
|
||||||
|
Ensures compliance with file system restrictions and application-specific requirements.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Core.PathValidator.ValidateAndResolveOutputFilePath(System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Validates that a destination file path is within the allowed output directory and that the directory exists.
|
||||||
|
Returns the full file path if validation passes.
|
||||||
|
</summary>
|
||||||
|
<param name="filePath">The file path to validate</param>
|
||||||
|
<param name="allowedOutputDirectory">The allowed output directory that the file must be within</param>
|
||||||
|
<returns>The full file path if valid</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.Range">
|
||||||
|
<summary>
|
||||||
|
Represents a rectangular range in a worksheet defined by starting and ending row and column indices.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.Range.FromRow">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the zero-based index of the first row in the range.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.Range.FromColumn">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the zero-based index of the starting column in the range.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.Range.ToRow">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the zero-based index of the last row in the range, inclusive.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.Range.ToColumn">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the zero-based, inclusive index of the ending column in the range.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.ToolAttribute">
|
||||||
|
<summary>
|
||||||
|
Marks a method as a tool that can be exposed to AI agents.
|
||||||
|
Use with [Description] attribute to provide tool documentation.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.ToolAttribute.Name">
|
||||||
|
<summary>
|
||||||
|
Optional custom name for the tool. If not specified, method name is used.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Core.ToolAttribute.IsEnabled">
|
||||||
|
<summary>
|
||||||
|
Whether this tool is enabled. Disabled tools are not registered.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Core.ToolResultHelpers">
|
||||||
|
<summary>
|
||||||
|
Shared helpers for building standard MCP tool results with consistent
|
||||||
|
success/error signaling and optional structured payloads.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,892 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Documents.AI.Tools.Fixed.Core</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.FixedDocumentContentTools">
|
||||||
|
<summary>
|
||||||
|
Provides static tools for creating and manipulating PDF document content.
|
||||||
|
These tools handle content segments including text, images, tables, and document structure.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.FixedDocumentFormTools">
|
||||||
|
<summary>
|
||||||
|
Provides static tools for working with PDF form fields.
|
||||||
|
These tools handle form field reading and filling operations.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.FixedDocumentFormUtilities">
|
||||||
|
<summary>
|
||||||
|
Utility class for PDF form-related operations including field information extraction,
|
||||||
|
form filling, and summary generation for interactive PDF forms.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.FixedDocumentFormUtilities.GetFormFieldInfo(Telerik.Documents.Fixed.Model.InteractiveForms.FormField)">
|
||||||
|
<summary>
|
||||||
|
Gets comprehensive information about a single form field and its properties.
|
||||||
|
Extracts type-specific information for text fields, checkboxes, combo boxes,
|
||||||
|
list boxes, radio buttons, and other interactive form elements.
|
||||||
|
</summary>
|
||||||
|
<param name="formField">The form field to extract information from.</param>
|
||||||
|
<returns>A <see cref="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo"/> object containing detailed information about the form field including its type, properties, and current values.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.FixedDocumentFormUtilities.GenerateFormSummary(System.Collections.Generic.List{Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo})">
|
||||||
|
<summary>
|
||||||
|
Generates a comprehensive summary of form fields including counts, field types,
|
||||||
|
and structural information about the PDF form.
|
||||||
|
</summary>
|
||||||
|
<param name="formFields">List of form field information objects to summarize.</param>
|
||||||
|
<returns>A formatted string containing statistics about the form fields including total count, required fields, read-only fields, and breakdown by field type.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.FixedDocumentFormUtilities.FillFormFieldsWithProvidedValues(Telerik.Documents.Fixed.Model.RadFixedDocument,System.Collections.Generic.Dictionary{System.String,Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldValue})">
|
||||||
|
<summary>
|
||||||
|
Fills form fields in a PDF document with provided values and returns a detailed summary of the operations.
|
||||||
|
Supports partial form filling, skips read-only fields, and provides comprehensive error reporting.
|
||||||
|
Field matching is performed by both field name and display name for flexibility.
|
||||||
|
</summary>
|
||||||
|
<param name="document">The PDF document containing interactive form fields to fill.</param>
|
||||||
|
<param name="fieldValues">Dictionary mapping field names to their corresponding values. Keys should match form field names or display names.</param>
|
||||||
|
<returns>A tuple containing:
|
||||||
|
- fieldsFilledCount: Number of fields successfully filled
|
||||||
|
- fieldsSummary: List of summary messages describing successful operations and skipped fields
|
||||||
|
- fieldErrors: List of error messages for fields that could not be filled
|
||||||
|
</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.FixedDocumentFormUtilities.GetUserFriendlyFieldName(Telerik.Documents.Fixed.Model.InteractiveForms.FormField)">
|
||||||
|
<summary>
|
||||||
|
Gets the user-friendly display name for a form field, preferring UserInterfaceName over Name.
|
||||||
|
This method provides a fallback mechanism to ensure a meaningful name is always returned.
|
||||||
|
</summary>
|
||||||
|
<param name="formField">The form field to get the display name for.</param>
|
||||||
|
<returns>The UserInterfaceName if available and not empty, otherwise returns the Name property. Returns null if both are null.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.FixedDocumentFormUtilities.GetFormFieldType(Telerik.Documents.Fixed.Model.InteractiveForms.FormField)">
|
||||||
|
<summary>
|
||||||
|
Gets the human-readable string representation of the form field type.
|
||||||
|
Provides specific type names for different field variants (e.g., distinguishes between
|
||||||
|
regular text fields, password fields, and multi-line text fields).
|
||||||
|
</summary>
|
||||||
|
<param name="formField">The form field to determine the type for.</param>
|
||||||
|
<returns>A descriptive string representing the field type. Returns the class name as fallback for unknown types.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.IFixedDocumentRepository">
|
||||||
|
<summary>
|
||||||
|
Provides a unified interface for managing PDF (Fixed) documents.
|
||||||
|
Extends IDocumentRepository with PDF-specific capabilities.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.InMemoryFixedDocumentRepository">
|
||||||
|
<summary>
|
||||||
|
Repository for multi-document orchestration scenarios.
|
||||||
|
Manages multiple PDF documents in memory with support for creation and import.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.InMemoryFixedDocumentRepository.#ctor(System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance with no documents.
|
||||||
|
</summary>
|
||||||
|
<param name="importTimeout">Timeout for import operations, or null to allow unlimited time.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.InMemoryFixedDocumentRepository.DocumentType">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.InMemoryFixedDocumentRepository.DefaultFormat">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.InMemoryFixedDocumentRepository.DefaultNewDocumentBaseName">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.InMemoryFixedDocumentRepository.CreateDocument(System.String,System.String[])">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.InMemoryFixedDocumentRepository.Export(System.String,Telerik.Documents.AI.Tools.Core.DocumentFormat,System.IO.Stream)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.InMemoryFixedDocumentRepository.Import(System.IO.Stream,Telerik.Documents.AI.Tools.Core.DocumentFormat,System.String)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.InMemoryFixedDocumentRepository.MergeAndExport(System.String[],System.IO.Stream,Telerik.Documents.AI.Tools.Core.DocumentFormat)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.InMemoryFixedDocumentRepository.AddDocument(System.String,Telerik.Documents.Fixed.Model.RadFixedDocument)">
|
||||||
|
<summary>
|
||||||
|
Adds an existing document to the repository.
|
||||||
|
</summary>
|
||||||
|
<param name="documentId">The identifier for the document.</param>
|
||||||
|
<param name="document">The document to add.</param>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ContentSegment">
|
||||||
|
<summary>
|
||||||
|
Base class for all content segments that can be added to PDF documents
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ContentSegment.SegmentType">
|
||||||
|
<summary>
|
||||||
|
The type of content segment
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment">
|
||||||
|
<summary>
|
||||||
|
Base class for text-based segments with formatting properties
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment.Text">
|
||||||
|
<summary>
|
||||||
|
The text content to add
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment.FontSize">
|
||||||
|
<summary>
|
||||||
|
Font size in points. Default is 12.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment.FontFamily">
|
||||||
|
<summary>
|
||||||
|
Font family name. Supported: 'Arial', 'Helvetica', 'Times', 'Times New Roman', 'Courier', 'Courier New'. Default is 'Arial'.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment.TextColor">
|
||||||
|
<summary>
|
||||||
|
Text color in hex format (e.g., '#FF0000' for red). Default is black.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment.HighlightColor">
|
||||||
|
<summary>
|
||||||
|
Highlight color in hex format (e.g., '#FFFF00' for yellow). Leave empty for no highlight.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment.Bold">
|
||||||
|
<summary>
|
||||||
|
Whether the text should be bold. Default is false.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment.Italic">
|
||||||
|
<summary>
|
||||||
|
Whether the text should be italic. Default is false.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment.Underline">
|
||||||
|
<summary>
|
||||||
|
Underline style: 'None' or 'Single'. Default is 'None'.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment.Strikethrough">
|
||||||
|
<summary>
|
||||||
|
Strikethrough style: 'None' or 'Single'. Default is 'None'.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment.BaselineAlignment">
|
||||||
|
<summary>
|
||||||
|
Baseline alignment: 'Baseline', 'Subscript', or 'Superscript'. Default is 'Baseline'.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment.HorizontalAlignment">
|
||||||
|
<summary>
|
||||||
|
Horizontal alignment of the paragraph containing this text: 'Left', 'Center', 'Right', 'Justified'. Leave empty to keep current alignment.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ImageSegment">
|
||||||
|
<summary>
|
||||||
|
Segment that inserts an image into the PDF document
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ImageSegment.SegmentType">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ImageSegment.ImagePath">
|
||||||
|
<summary>
|
||||||
|
The path to the image file to insert. Supports common formats: JPEG, PNG, BMP, TIFF, GIF. Must be an absolute path or relative to the current working directory.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ImageSegment.Width">
|
||||||
|
<summary>
|
||||||
|
The width of the image in points. If not specified, the original image width will be used. Must be a positive number.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ImageSegment.Height">
|
||||||
|
<summary>
|
||||||
|
The height of the image in points. If not specified, the original image height will be used. Must be a positive number.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ImageSegment.MaintainAspectRatio">
|
||||||
|
<summary>
|
||||||
|
Whether to maintain the original aspect ratio when width or height is specified. If true, the image will be scaled proportionally. Default is true.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.LineSegment">
|
||||||
|
<summary>
|
||||||
|
Text segment that inserts formatted text followed by a line break
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.LineSegment.SegmentType">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.PageBreakSegment">
|
||||||
|
<summary>
|
||||||
|
Segment that forces content to start on a new page
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.PageBreakSegment.SegmentType">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ParagraphBreakSegment">
|
||||||
|
<summary>
|
||||||
|
Segment that starts a new paragraph with configurable paragraph properties
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ParagraphBreakSegment.SegmentType">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ParagraphBreakSegment.SpacingBefore">
|
||||||
|
<summary>
|
||||||
|
Spacing before the paragraph in points. Default is 0.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ParagraphBreakSegment.SpacingAfter">
|
||||||
|
<summary>
|
||||||
|
Spacing after the paragraph in points. Default is 0.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ParagraphBreakSegment.LeftIndent">
|
||||||
|
<summary>
|
||||||
|
Left indent in points. Default is 0.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ParagraphBreakSegment.RightIndent">
|
||||||
|
<summary>
|
||||||
|
Right indent in points. Default is 0.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ParagraphBreakSegment.FirstLineIndent">
|
||||||
|
<summary>
|
||||||
|
First line indent in points. Default is 0.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ParagraphBreakSegment.HorizontalAlignment">
|
||||||
|
<summary>
|
||||||
|
Horizontal alignment: 'Left', 'Center', 'Right', 'Justified'. Default is 'Left'.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ParagraphBreakSegment.BackgroundColor">
|
||||||
|
<summary>
|
||||||
|
Background color for the paragraph in hex format (e.g., '#FFFFFF'). Leave empty for no background.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.RunSegment">
|
||||||
|
<summary>
|
||||||
|
Text segment that inserts inline formatted text without line breaks
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.RunSegment.SegmentType">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.SectionBreakSegment">
|
||||||
|
<summary>
|
||||||
|
Segment that starts a new section with different page properties
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.SectionBreakSegment.SegmentType">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.SectionBreakSegment.PageSize">
|
||||||
|
<summary>
|
||||||
|
Page size for the new section: 'A4', 'Letter', 'Legal', 'A3', 'A5'. Default is 'A4'.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.SectionBreakSegment.PageRotation">
|
||||||
|
<summary>
|
||||||
|
Page rotation: 'Rotate0', 'Rotate90', 'Rotate180', 'Rotate270'. Default is 'Rotate0'.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.TableSegment">
|
||||||
|
<summary>
|
||||||
|
Segment that inserts a table into the PDF document
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.TableSegment.SegmentType">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.TableSegment.Rows">
|
||||||
|
<summary>
|
||||||
|
Array of table rows. Each row is an array of cell data (strings).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.TableSegment.Headers">
|
||||||
|
<summary>
|
||||||
|
Optional array of header cells for the table. If provided, will be formatted differently from regular rows.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.TableSegment.ShowBorders">
|
||||||
|
<summary>
|
||||||
|
Whether the table should have borders. Default is true.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.TableSegment.HeaderBackgroundColor">
|
||||||
|
<summary>
|
||||||
|
Background color for header row in hex format (e.g., '#F0F0F0'). Only applied if headers are provided.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.TableSegment.HeaderTextColor">
|
||||||
|
<summary>
|
||||||
|
Text color for header row in hex format (e.g., '#000000'). Only applied if headers are provided.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.TableSegment.HeaderFontSize">
|
||||||
|
<summary>
|
||||||
|
Font size for header text in points. Default is 12.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.TableSegment.FontSize">
|
||||||
|
<summary>
|
||||||
|
Font size for table text in points. Default is 10.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.CheckBoxInfo">
|
||||||
|
<summary>
|
||||||
|
Detailed information about checkbox field properties
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.CheckBoxInfo.IsChecked">
|
||||||
|
<summary>
|
||||||
|
Whether the checkbox is currently checked
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.CheckBoxInfo.ExportValue">
|
||||||
|
<summary>
|
||||||
|
The export value when the checkbox is checked
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.ComboBoxInfo">
|
||||||
|
<summary>
|
||||||
|
Detailed information about combo box field properties
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.ComboBoxInfo.Options">
|
||||||
|
<summary>
|
||||||
|
Array of available options in the combo box
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.ComboBoxInfo.SelectedValue">
|
||||||
|
<summary>
|
||||||
|
Currently selected value
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.ListBoxInfo">
|
||||||
|
<summary>
|
||||||
|
Detailed information about list box field properties
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.ListBoxInfo.Options">
|
||||||
|
<summary>
|
||||||
|
Array of available options in the list box
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.ListBoxInfo.SelectedValues">
|
||||||
|
<summary>
|
||||||
|
Array of currently selected values
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.ListBoxInfo.AllowMultiSelection">
|
||||||
|
<summary>
|
||||||
|
Whether the list box allows multiple selections
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo">
|
||||||
|
<summary>
|
||||||
|
Detailed information about a PDF form field
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo.Name">
|
||||||
|
<summary>
|
||||||
|
The internal name/identifier of the form field
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo.UserInterfaceName">
|
||||||
|
<summary>
|
||||||
|
The user-friendly interface name of the form field
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo.DisplayName">
|
||||||
|
<summary>
|
||||||
|
The best display name for the field (UserInterfaceName if available, otherwise Name)
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo.FieldType">
|
||||||
|
<summary>
|
||||||
|
The type of form field (e.g., 'Text Field', 'Checkbox Field', 'Combo Box Field')
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo.IsRequired">
|
||||||
|
<summary>
|
||||||
|
Whether this field is required to be filled
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo.IsReadOnly">
|
||||||
|
<summary>
|
||||||
|
Whether this field is read-only and cannot be modified
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo.TextFieldInfo">
|
||||||
|
<summary>
|
||||||
|
Detailed information for text fields (null for other field types)
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo.CheckBoxInfo">
|
||||||
|
<summary>
|
||||||
|
Detailed information for checkbox fields (null for other field types)
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo.ComboBoxInfo">
|
||||||
|
<summary>
|
||||||
|
Detailed information for combo box fields (null for other field types)
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo.ListBoxInfo">
|
||||||
|
<summary>
|
||||||
|
Detailed information for list box fields (null for other field types)
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo.RadioButtonInfo">
|
||||||
|
<summary>
|
||||||
|
Detailed information for radio button fields (null for other field types)
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldValue">
|
||||||
|
<summary>
|
||||||
|
Value to be set for a specific form field
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldValue.FieldName">
|
||||||
|
<summary>
|
||||||
|
The name/identifier of the form field
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldValue.TextValue">
|
||||||
|
<summary>
|
||||||
|
The value to set for text fields, combo boxes, and comb text fields
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldValue.BooleanValue">
|
||||||
|
<summary>
|
||||||
|
The checked state for checkbox fields
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldValue.ArrayValue">
|
||||||
|
<summary>
|
||||||
|
Array of selected values for list box and radio button fields
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldValues">
|
||||||
|
<summary>
|
||||||
|
Container for form field values to be filled into a PDF form
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldValues.FieldValues">
|
||||||
|
<summary>
|
||||||
|
Dictionary of field name to field value mappings
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormResult">
|
||||||
|
<summary>
|
||||||
|
Result of getting PDF form fields information
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormResult.HasFormFields">
|
||||||
|
<summary>
|
||||||
|
Whether the PDF contains interactive form fields
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormResult.TotalFieldCount">
|
||||||
|
<summary>
|
||||||
|
Total number of form fields found
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormResult.FormFields">
|
||||||
|
<summary>
|
||||||
|
Array of detailed information about each form field
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormResult.Summary">
|
||||||
|
<summary>
|
||||||
|
Summary description of the form analysis results
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.RadioButtonInfo">
|
||||||
|
<summary>
|
||||||
|
Detailed information about radio button field properties
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.RadioButtonInfo.Options">
|
||||||
|
<summary>
|
||||||
|
Array of available radio button options
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.RadioButtonInfo.SelectedValue">
|
||||||
|
<summary>
|
||||||
|
Currently selected option
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.TextFieldInfo">
|
||||||
|
<summary>
|
||||||
|
Detailed information about text field properties
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.TextFieldInfo.Value">
|
||||||
|
<summary>
|
||||||
|
Current text value of the field
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.TextFieldInfo.MaxLength">
|
||||||
|
<summary>
|
||||||
|
Maximum number of characters allowed (0 means no limit)
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.TextFieldInfo.IsMultiline">
|
||||||
|
<summary>
|
||||||
|
Whether the field supports multiple lines of text
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.TextFieldInfo.IsPassword">
|
||||||
|
<summary>
|
||||||
|
Whether the field is a password field (text is masked)
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.TextFieldInfo.IsComb">
|
||||||
|
<summary>
|
||||||
|
Whether the field uses comb formatting (fixed-width character cells)
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.PdfFormUtilities">
|
||||||
|
<summary>
|
||||||
|
Utility class for PDF form-related operations including field information extraction,
|
||||||
|
form filling, and summary generation for interactive PDF forms.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfFormUtilities.GetFormFieldInfo(Telerik.Documents.Fixed.Model.InteractiveForms.FormField)">
|
||||||
|
<summary>
|
||||||
|
Gets comprehensive information about a single form field and its properties.
|
||||||
|
Extracts type-specific information for text fields, checkboxes, combo boxes,
|
||||||
|
list boxes, radio buttons, and other interactive form elements.
|
||||||
|
</summary>
|
||||||
|
<param name="formField">The form field to extract information from.</param>
|
||||||
|
<returns>A <see cref="T:Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo"/> object containing detailed information about the form field including its type, properties, and current values.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfFormUtilities.GenerateFormSummary(System.Collections.Generic.List{Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldInfo})">
|
||||||
|
<summary>
|
||||||
|
Generates a comprehensive summary of form fields including counts, field types,
|
||||||
|
and structural information about the PDF form.
|
||||||
|
</summary>
|
||||||
|
<param name="formFields">List of form field information objects to summarize.</param>
|
||||||
|
<returns>A formatted string containing statistics about the form fields including total count, required fields, read-only fields, and breakdown by field type.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfFormUtilities.FillFormFieldsWithProvidedValues(Telerik.Documents.Fixed.Model.RadFixedDocument,System.Collections.Generic.Dictionary{System.String,Telerik.Documents.AI.Tools.Fixed.Core.Models.Forms.PdfFormFieldValue})">
|
||||||
|
<summary>
|
||||||
|
Fills form fields in a PDF document with provided values and returns a detailed summary of the operations.
|
||||||
|
Supports partial form filling, skips read-only fields, and provides comprehensive error reporting.
|
||||||
|
Field matching is performed by both field name and display name for flexibility.
|
||||||
|
</summary>
|
||||||
|
<param name="document">The PDF document containing interactive form fields to fill.</param>
|
||||||
|
<param name="fieldValues">Dictionary mapping field names to their corresponding values. Keys should match form field names or display names.</param>
|
||||||
|
<returns>A tuple containing:
|
||||||
|
- fieldsFilledCount: Number of fields successfully filled
|
||||||
|
- fieldsSummary: List of summary messages describing successful operations and skipped fields
|
||||||
|
- fieldErrors: List of error messages for fields that could not be filled
|
||||||
|
</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfFormUtilities.GetUserFriendlyFieldName(Telerik.Documents.Fixed.Model.InteractiveForms.FormField)">
|
||||||
|
<summary>
|
||||||
|
Gets the user-friendly display name for a form field, preferring UserInterfaceName over Name.
|
||||||
|
This method provides a fallback mechanism to ensure a meaningful name is always returned.
|
||||||
|
</summary>
|
||||||
|
<param name="formField">The form field to get the display name for.</param>
|
||||||
|
<returns>The UserInterfaceName if available and not empty, otherwise returns the Name property. Returns null if both are null.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfFormUtilities.GetFormFieldType(Telerik.Documents.Fixed.Model.InteractiveForms.FormField)">
|
||||||
|
<summary>
|
||||||
|
Gets the human-readable string representation of the form field type.
|
||||||
|
Provides specific type names for different field variants (e.g., distinguishes between
|
||||||
|
regular text fields, password fields, and multi-line text fields).
|
||||||
|
</summary>
|
||||||
|
<param name="formField">The form field to determine the type for.</param>
|
||||||
|
<returns>A descriptive string representing the field type. Returns the class name as fallback for unknown types.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities">
|
||||||
|
<summary>
|
||||||
|
Comprehensive utility class for PDF document operations including content segment processing,
|
||||||
|
text formatting, image insertion, table creation, and document structure management.
|
||||||
|
Provides methods for converting various content types into PDF elements using Telerik RadPdfProcessing.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.ConvertStringToPaperType(System.String)">
|
||||||
|
<summary>
|
||||||
|
Converts a string representation of page size to PaperTypes enum.
|
||||||
|
</summary>
|
||||||
|
<param name="pageSize">The page size string (case-insensitive). Supported values: 'A4', 'Letter', 'Legal', 'A3', 'A5'.</param>
|
||||||
|
<returns>The corresponding PaperTypes enum value, defaults to A4 for unrecognized values.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.RemoveTrailingPageBreaks(Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ContentSegment[])">
|
||||||
|
<summary>
|
||||||
|
Removes trailing PageBreak segments from content segments array to prevent empty pages
|
||||||
|
when the segments are processed by a PDF document editor.
|
||||||
|
</summary>
|
||||||
|
<param name="contentSegments">Array of content segments to process.</param>
|
||||||
|
<returns>A new array of content segments with any trailing PageBreak segments removed.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.ProcessContentSegment(Telerik.Documents.Fixed.Model.Editing.RadFixedDocumentEditor,Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ContentSegment)">
|
||||||
|
<summary>
|
||||||
|
Processes a content segment by calling the appropriate handler based on segment type.
|
||||||
|
Supports text runs, lines, paragraph breaks, page breaks, section breaks, images, and tables.
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The RadFixedDocumentEditor instance used to insert content into the PDF document.</param>
|
||||||
|
<param name="segment">The content segment to process. The segment type determines which processing method is called.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.ProcessTextSegment(Telerik.Documents.Fixed.Model.Editing.RadFixedDocumentEditor,Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.FormattedTextSegment,System.Boolean)">
|
||||||
|
<summary>
|
||||||
|
Processes a formatted text segment, applying all text formatting properties including font,
|
||||||
|
color, decorations, and baseline alignment before inserting the text into the document.
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The RadFixedDocumentEditor to use for text insertion.</param>
|
||||||
|
<param name="segment">The formatted text segment containing text content and formatting properties.</param>
|
||||||
|
<param name="addLineBreak">If true, inserts text as a line (with line break); if false, inserts as a run (inline).</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.ProcessParagraphBreakSegment(Telerik.Documents.Fixed.Model.Editing.RadFixedDocumentEditor,Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ParagraphBreakSegment)">
|
||||||
|
<summary>
|
||||||
|
Processes a paragraph break segment, applying paragraph formatting properties such as spacing,
|
||||||
|
indentation, alignment, and background color before inserting a paragraph break.
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The RadFixedDocumentEditor to use for paragraph insertion.</param>
|
||||||
|
<param name="segment">The paragraph break segment containing paragraph formatting properties.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.ProcessSectionBreakSegment(Telerik.Documents.Fixed.Model.Editing.RadFixedDocumentEditor,Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.SectionBreakSegment)">
|
||||||
|
<summary>
|
||||||
|
Processes a section break segment, configuring new section properties including page size
|
||||||
|
and rotation before inserting a section break that starts a new section in the document.
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The RadFixedDocumentEditor to use for section break insertion.</param>
|
||||||
|
<param name="segment">The section break segment containing page size and rotation settings.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.ProcessImageSegment(Telerik.Documents.Fixed.Model.Editing.RadFixedDocumentEditor,Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ImageSegment)">
|
||||||
|
<summary>
|
||||||
|
Processes an image segment by loading the image file and inserting it into the document
|
||||||
|
with the specified dimensions and aspect ratio settings.
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The RadFixedDocumentEditor to use for image insertion.</param>
|
||||||
|
<param name="segment">The image segment containing file path and sizing information.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.ProcessTableSegment(Telerik.Documents.Fixed.Model.Editing.RadFixedDocumentEditor,Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.TableSegment)">
|
||||||
|
<summary>
|
||||||
|
Processes a table segment by creating a formatted table with the specified data, headers,
|
||||||
|
borders, and styling options, then inserting it into the document.
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The RadFixedDocumentEditor to use for table insertion.</param>
|
||||||
|
<param name="segment">The table segment containing table data, headers, and formatting options.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.SetFontProperties(Telerik.Documents.Fixed.Model.Editing.RadFixedDocumentEditor,System.String,System.Boolean,System.Boolean)">
|
||||||
|
<summary>
|
||||||
|
Sets font properties for the document editor, selecting appropriate font from the FontsRepository
|
||||||
|
based on family name and style requirements. Falls back to Helvetica if font selection fails.
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The RadFixedDocumentEditor to configure.</param>
|
||||||
|
<param name="fontFamily">Font family name. Supported: "Arial", "Helvetica", "Times", "Times New Roman", "Courier", "Courier New".</param>
|
||||||
|
<param name="bold">Whether text should be bold (uses bold font variant).</param>
|
||||||
|
<param name="italic">Whether text should be italic (uses italic/oblique font variant).</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.SetTextColors(Telerik.Documents.Fixed.Model.Editing.RadFixedDocumentEditor,System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Sets text foreground and highlight background colors for the document editor.
|
||||||
|
Text color defaults to black if not provided or invalid.
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The RadFixedDocumentEditor to configure.</param>
|
||||||
|
<param name="textColor">Text foreground color in hex format (e.g., "#FF0000"). If null/empty/invalid, defaults to black.</param>
|
||||||
|
<param name="highlightColor">Text highlight background color in hex format (e.g., "#FFFF00"). If null/empty/invalid, no highlight is applied.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.SetTextDecorations(Telerik.Documents.Fixed.Model.Editing.RadFixedDocumentEditor,System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Sets text decoration patterns (underline and strikethrough) for the document editor.
|
||||||
|
Both decorations default to "None" if not specified or unrecognized.
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The RadFixedDocumentEditor to configure.</param>
|
||||||
|
<param name="underline">Underline style. Supported values: "Single", "None". Case-insensitive.</param>
|
||||||
|
<param name="strikethrough">Strikethrough style. Supported values: "Single", "None". Case-insensitive.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.SetBaselineAlignment(Telerik.Documents.Fixed.Model.Editing.RadFixedDocumentEditor,System.String)">
|
||||||
|
<summary>
|
||||||
|
Sets baseline alignment for the document editor to control vertical text positioning
|
||||||
|
relative to the baseline (normal, subscript, or superscript).
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The RadFixedDocumentEditor to configure.</param>
|
||||||
|
<param name="baselineAlignment">Baseline alignment setting. Supported values: "Baseline", "Subscript", "Superscript". Case-insensitive. Defaults to "Baseline".</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.ParseColor(System.String)">
|
||||||
|
<summary>
|
||||||
|
Parses a color string in hex format into a Telerik RgbColor object for use in PDF documents.
|
||||||
|
Uses System.Drawing.ColorTranslator for robust color parsing.
|
||||||
|
</summary>
|
||||||
|
<param name="color">Color string in hex format (e.g., "#FF0000", "#ffffff").</param>
|
||||||
|
<returns>RgbColor object if parsing succeeds, null if color is null/empty.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.CalculateImageSize(Telerik.Documents.Fixed.Model.Resources.ImageSource,System.Nullable{System.Double},System.Nullable{System.Double},System.Boolean)">
|
||||||
|
<summary>
|
||||||
|
Calculates the final size for an image based on the provided width, height, and aspect ratio settings.
|
||||||
|
When maintaining aspect ratio, chooses the scaling constraint that results in the smaller scaling factor
|
||||||
|
to ensure the image fits within both specified dimensions.
|
||||||
|
</summary>
|
||||||
|
<param name="imageSource">The image source containing original dimensions.</param>
|
||||||
|
<param name="width">Desired width in points. If null, original width is used unless height is specified with aspect ratio maintenance.</param>
|
||||||
|
<param name="height">Desired height in points. If null, original height is used unless width is specified with aspect ratio maintenance.</param>
|
||||||
|
<param name="maintainAspectRatio">If true, preserves original aspect ratio by scaling proportionally. If false, uses exact specified dimensions.</param>
|
||||||
|
<returns>A Size object representing the calculated final dimensions for the image.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.LoadAndInsertImageIntoEditor(Telerik.Documents.Fixed.Model.Editing.RadFixedDocumentEditor,System.String,System.Nullable{System.Double},System.Nullable{System.Double},System.Boolean)">
|
||||||
|
<summary>
|
||||||
|
Loads an image from the specified file path and inserts it inline into the PDF document at the current position.
|
||||||
|
Calculates final dimensions based on size constraints and aspect ratio settings before insertion.
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The RadFixedDocumentEditor to insert the image into.</param>
|
||||||
|
<param name="imagePath">The absolute or relative path to the image file.</param>
|
||||||
|
<param name="width">Optional width constraint in points. If null, uses original width or calculated width based on height and aspect ratio.</param>
|
||||||
|
<param name="height">Optional height constraint in points. If null, uses original height or calculated height based on width and aspect ratio.</param>
|
||||||
|
<param name="maintainAspectRatio">If true, maintains original aspect ratio when scaling. If false, uses exact specified dimensions.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfUtilities.CreateAndInsertTable(Telerik.Documents.Fixed.Model.Editing.RadFixedDocumentEditor,System.String[][],System.String[],System.Boolean,System.String,System.String,System.Double,System.Double)">
|
||||||
|
<summary>
|
||||||
|
Creates and inserts a formatted table into the PDF document using the RadFixedDocumentEditor.
|
||||||
|
Implements proper table creation patterns based on official Telerik SDK guidelines,
|
||||||
|
including optional headers, borders, and comprehensive styling options.
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The RadFixedDocumentEditor to insert the table into.</param>
|
||||||
|
<param name="rows">Array of table data rows, where each row is an array of cell values.</param>
|
||||||
|
<param name="headers">Optional array of header cell values. If provided, creates a styled header row. Can be null to skip headers.</param>
|
||||||
|
<param name="showBorders">If true, applies black borders to the table and all cells with small padding. If false, creates a borderless table.</param>
|
||||||
|
<param name="headerBackgroundColor">Background color for header cells in hex format (e.g., "#F0F0F0"). Only applied if headers are provided. Can be null or empty.</param>
|
||||||
|
<param name="headerTextColor">Text color for header cells in hex format (e.g., "#000000"). Only applied if headers are provided. Can be null or empty.</param>
|
||||||
|
<param name="headerFontSize">Font size in points for header text.</param>
|
||||||
|
<param name="fontSize">Font size in points for regular table cell text.</param>
|
||||||
|
<example>
|
||||||
|
<code>
|
||||||
|
var tableData = new string[][] {
|
||||||
|
new[] { "Product", "Price", "Stock" },
|
||||||
|
new[] { "Widget A", "$10.99", "25" },
|
||||||
|
new[] { "Widget B", "$15.99", "10" }
|
||||||
|
};
|
||||||
|
var headers = new[] { "Item", "Cost", "Available" };
|
||||||
|
CreateAndInsertTable(editor, tableData, headers, true, "#E0E0E0", "#000000", 12, 10);
|
||||||
|
</code>
|
||||||
|
</example>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator">
|
||||||
|
<summary>
|
||||||
|
Provides validation utilities for PDF-related operations.
|
||||||
|
Ensures PDF file descriptors and properties meet application requirements.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateContentSegment(Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ContentSegment,System.Int32,System.String)">
|
||||||
|
<summary>
|
||||||
|
Validates content segment based on its type and properties.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateFormattedTextParameters(System.String,System.Double,System.String,System.String,System.String,System.String,System.String,System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Validates formatted text parameters including content, font, colors, and styling options.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateFontSize(System.Double)">
|
||||||
|
<summary>
|
||||||
|
Validates font size is within acceptable bounds.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateFontFamily(System.String)">
|
||||||
|
<summary>
|
||||||
|
Validates font family is supported.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateColor(System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Validates color format (hex format required).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateUnderlinePattern(System.String)">
|
||||||
|
<summary>
|
||||||
|
Validates underline pattern is supported.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateStrikethroughPattern(System.String)">
|
||||||
|
<summary>
|
||||||
|
Validates strikethrough pattern is supported.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateBaselineAlignment(System.String)">
|
||||||
|
<summary>
|
||||||
|
Validates baseline alignment is supported.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateHorizontalAlignment(System.String)">
|
||||||
|
<summary>
|
||||||
|
Validates horizontal alignment is supported (optional field).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateParagraphBreakSegment(Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ParagraphBreakSegment)">
|
||||||
|
<summary>
|
||||||
|
Validates paragraph break segment properties.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateSectionBreakSegment(Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.SectionBreakSegment)">
|
||||||
|
<summary>
|
||||||
|
Validates section break segment properties.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateImageSegment(Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.ImageSegment,System.String)">
|
||||||
|
<summary>
|
||||||
|
Validates image segment properties.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateTableSegment(Telerik.Documents.AI.Tools.Fixed.Core.Models.ContentSegments.TableSegment)">
|
||||||
|
<summary>
|
||||||
|
Validates table segment properties.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateImagePath(System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Validates that an image path is within the configured image directory and exists.
|
||||||
|
Requires explicit permission via IMAGE_DIR environment variable for security.
|
||||||
|
</summary>
|
||||||
|
<param name="imagePath">The image file path to validate</param>
|
||||||
|
<param name="imageDirectory">The configured image directory (required for security)</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateImageParameters(System.String,System.Nullable{System.Double},System.Nullable{System.Double},System.String)">
|
||||||
|
<summary>
|
||||||
|
Validates image parameters by reusing the comprehensive ImageSegment validation.
|
||||||
|
This reduces code duplication between InsertImage and ValidateImageSegment methods.
|
||||||
|
</summary>
|
||||||
|
<param name="imagePath">The image file path to validate</param>
|
||||||
|
<param name="width">Optional width constraint</param>
|
||||||
|
<param name="height">Optional height constraint</param>
|
||||||
|
<param name="imageDirectory">The configured image directory for security validation</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.PdfValidator.ValidateTableData(System.String[][],System.String[],System.String,System.String,System.Double,System.Double)">
|
||||||
|
<summary>
|
||||||
|
Validates table data including rows, headers, and formatting parameters.
|
||||||
|
</summary>
|
||||||
|
<param name="rows">Array of table rows</param>
|
||||||
|
<param name="headers">Optional header row</param>
|
||||||
|
<param name="headerBackgroundColor">Header background color</param>
|
||||||
|
<param name="headerTextColor">Header text color</param>
|
||||||
|
<param name="headerFontSize">Font size for header text</param>
|
||||||
|
<param name="fontSize">Font size for table text</param>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Fixed.Core.ServiceCollectionExtensions">
|
||||||
|
<summary>
|
||||||
|
Provides extension methods for registering Fixed document agent tools and related services with an <see
|
||||||
|
cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Fixed.Core.ServiceCollectionExtensions.AddFixedAgentTools(Microsoft.Extensions.DependencyInjection.IServiceCollection,Telerik.Documents.AI.Tools.Core.DocumentProcessingOptions)">
|
||||||
|
<summary>
|
||||||
|
Adds Fixed document agent tools to the service collection.
|
||||||
|
</summary>
|
||||||
|
<param name="services">The service collection.</param>
|
||||||
|
<param name="options">Configuration options for document processing.</param>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,62 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Documents.AI.Tools.Flow.Core</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Flow.Core.IFlowDocumentRepository">
|
||||||
|
<summary>
|
||||||
|
Provides a unified interface for managing flow documents.
|
||||||
|
Extends IDocumentRepository with flow-specific creation capabilities.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Flow.Core.InMemoryFlowDocumentRepository">
|
||||||
|
<summary>
|
||||||
|
Repository for multi-document orchestration scenarios.
|
||||||
|
Manages multiple flow documents in memory with support for creation and import.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Flow.Core.InMemoryFlowDocumentRepository.#ctor(System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance with no documents.
|
||||||
|
</summary>
|
||||||
|
<param name="importTimeout">Timeout for import operations, or null to allow unlimited time.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Flow.Core.InMemoryFlowDocumentRepository.DocumentType">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Flow.Core.InMemoryFlowDocumentRepository.DefaultFormat">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Flow.Core.InMemoryFlowDocumentRepository.DefaultNewDocumentBaseName">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Flow.Core.InMemoryFlowDocumentRepository.CreateDocument(System.String,System.String[])">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Flow.Core.InMemoryFlowDocumentRepository.Export(System.String,Telerik.Documents.AI.Tools.Core.DocumentFormat,System.IO.Stream)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Flow.Core.InMemoryFlowDocumentRepository.Import(System.IO.Stream,Telerik.Documents.AI.Tools.Core.DocumentFormat,System.String)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Flow.Core.InMemoryFlowDocumentRepository.ExportToPdf(System.String,System.IO.Stream)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Flow.Core.InMemoryFlowDocumentRepository.MergeAndExport(System.String[],System.IO.Stream,Telerik.Documents.AI.Tools.Core.DocumentFormat)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Flow.Core.ServiceCollectionExtensions">
|
||||||
|
<summary>
|
||||||
|
Provides extension methods for registering Flow document agent tools with an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Flow.Core.ServiceCollectionExtensions.AddFlowAgentTools(Microsoft.Extensions.DependencyInjection.IServiceCollection,Telerik.Documents.AI.Tools.Core.DocumentProcessingOptions)">
|
||||||
|
<summary>
|
||||||
|
Adds Flow document agent tools to the service collection.
|
||||||
|
</summary>
|
||||||
|
<param name="services">The service collection.</param>
|
||||||
|
<param name="options">Configuration options for document processing.</param>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,407 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Documents.AI.Tools.Spreadsheet.Core</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.InMemoryWorkbookRepository">
|
||||||
|
<summary>
|
||||||
|
Repository for multi-document orchestration scenarios.
|
||||||
|
Manages multiple workbooks in memory with support for creation and import.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.InMemoryWorkbookRepository.#ctor(System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance with no documents.
|
||||||
|
</summary>
|
||||||
|
<param name="importTimeout">Timeout for import operations, or null to allow unlimited time. For security against DDoS attacks, explicitly choose a value or null.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Spreadsheet.Core.InMemoryWorkbookRepository.DocumentType">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Spreadsheet.Core.InMemoryWorkbookRepository.DefaultFormat">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Spreadsheet.Core.InMemoryWorkbookRepository.DefaultNewDocumentBaseName">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.InMemoryWorkbookRepository.CreateDocument(System.String,System.String[])">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.InMemoryWorkbookRepository.Export(System.String,Telerik.Documents.AI.Tools.Core.DocumentFormat,System.IO.Stream)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.InMemoryWorkbookRepository.Import(System.IO.Stream,Telerik.Documents.AI.Tools.Core.DocumentFormat,System.String)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.InMemoryWorkbookRepository.ExportToPdf(System.String,System.IO.Stream)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.InMemoryWorkbookRepository.MergeAndExport(System.String[],System.IO.Stream,Telerik.Documents.AI.Tools.Core.DocumentFormat)">
|
||||||
|
<inheritdoc/>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.IWorkbookRepository">
|
||||||
|
<summary>
|
||||||
|
Provides a unified interface for managing spreadsheet workbooks.
|
||||||
|
Extends IDocumentRepository with spreadsheet-specific creation capabilities.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.ServiceCollectionExtensions">
|
||||||
|
<summary>
|
||||||
|
Provides extension methods for registering Spreadsheet agent tools and related services with an <see
|
||||||
|
cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.ServiceCollectionExtensions.AddSpreadsheetAgentTools(Microsoft.Extensions.DependencyInjection.IServiceCollection,Telerik.Documents.AI.Tools.Core.DocumentProcessingOptions)">
|
||||||
|
<summary>
|
||||||
|
Adds Spreadsheet agent tools to the service collection.
|
||||||
|
</summary>
|
||||||
|
<param name="services">The service collection.</param>
|
||||||
|
<param name="options">Configuration options for document processing.</param>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingFormulaTools">
|
||||||
|
<summary>
|
||||||
|
Formula and calculation tools for spreadsheets.
|
||||||
|
These tools allow formula evaluation and discovery without modifying the document.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingReadTools">
|
||||||
|
<summary>
|
||||||
|
Read-only spreadsheet tools for querying and analyzing workbook data without modification.
|
||||||
|
These tools are safe for analysis-only scenarios.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingWorksheetTools">
|
||||||
|
<summary>
|
||||||
|
Worksheet management tools for creating, deleting, and organizing worksheets in a workbook.
|
||||||
|
These tools modify the workbook structure but not cell content.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingWriteTools">
|
||||||
|
<summary>
|
||||||
|
Document editing tools for writing data, applying styles, and formatting spreadsheets.
|
||||||
|
These tools modify cell content and formatting in the workbook.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools">
|
||||||
|
<summary>
|
||||||
|
Core implementation of high-level data analysis tools for spreadsheets
|
||||||
|
using Split-Apply-Combine operations.
|
||||||
|
These tools enable filtering, grouping, and aggregation without requiring formula knowledge.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.DescribeData(System.String,System.String,System.Boolean)">
|
||||||
|
<summary>
|
||||||
|
Gets worksheet structure and column information in a single call.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.Aggregate(System.String,System.String,Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregationType,System.Nullable{System.Int32},System.String,System.Collections.Generic.List{Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.Criterion},Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriteriaLogic,System.Collections.Generic.List{System.Int32},System.Nullable{Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.SortOrder},System.Nullable{System.Int32},Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.HavingCriterion,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
||||||
|
<summary>
|
||||||
|
Aggregates data with optional filtering and grouping.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.GetRows(System.String,System.String,System.Collections.Generic.List{Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.Criterion},Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriteriaLogic,System.Collections.Generic.List{System.Int32},System.Int32,System.Int32,System.Nullable{System.Int32})">
|
||||||
|
<summary>
|
||||||
|
Retrieves rows matching filter criteria.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.DescribeSingleRegion(Telerik.Documents.Spreadsheet.Model.Worksheet,Telerik.Documents.Spreadsheet.Model.CellRange,System.Text.StringBuilder)">
|
||||||
|
<summary>
|
||||||
|
Describes a single data region (default mode).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.DescribeColumn(Telerik.Documents.Spreadsheet.Model.Worksheet,System.Int32,System.Int32,System.Int32,System.Int32,System.Text.StringBuilder)">
|
||||||
|
<summary>
|
||||||
|
Describes a single column with header, type, and samples.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.AnalyzeColumn(Telerik.Documents.Spreadsheet.Model.Worksheet,System.Int32,System.Int32,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Analyzes a column to determine type and sample values.
|
||||||
|
Uses GetCellData for proper type inference including date detection.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.DescribeRegionBlock(Telerik.Documents.Spreadsheet.Model.Worksheet,Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.DataRegion,System.Text.StringBuilder)">
|
||||||
|
<summary>
|
||||||
|
Formats one region's block for multi-region DescribeData output.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.AppendChartsAndImagesSection(Telerik.Documents.Spreadsheet.Model.Worksheet,System.Text.StringBuilder)">
|
||||||
|
<summary>
|
||||||
|
Appends a summary of charts and images present on the worksheet, if any.
|
||||||
|
Shown at the end of both single-region and multi-region DescribeData output so the
|
||||||
|
LLM is aware of non-tabular visual content when describing the sheet.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.DetectHierarchicalSumPattern(Telerik.Documents.Spreadsheet.Model.Worksheet,System.Int32,System.Int32,System.Int32,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Scans the data range for cells whose value is a SUM formula that references the same
|
||||||
|
column — a definitive structural sign that the column contains both individual rows and
|
||||||
|
computed aggregates of those rows (financial statement / hierarchical outline pattern).
|
||||||
|
Returns a human-readable description of the first such cell found (e.g. "B12 contains
|
||||||
|
=SUM(B2:B11)"), or null when none is found.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.AppendHierarchicalDataWarning(Telerik.Documents.Spreadsheet.Model.Worksheet,System.Int32,System.Int32,System.Int32,System.Int32,System.Text.StringBuilder)">
|
||||||
|
<summary>
|
||||||
|
Appends a prominent warning to the DescribeData output when a SUM formula referencing
|
||||||
|
the same column is found — the definitive structural indicator of hierarchical data
|
||||||
|
(financial statements, outlines) where summing naively would double-count.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.DetectRegions(Telerik.Documents.Spreadsheet.Model.Worksheet)">
|
||||||
|
<summary>
|
||||||
|
Scans the worksheet for rectangular data blocks separated by empty rows.
|
||||||
|
Returns regions sorted by data row count descending so index 0 is always the
|
||||||
|
largest (primary) table. Each region's column extent is detected independently.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.PerformAggregation(Telerik.Documents.Spreadsheet.Model.Worksheet,Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregationType,System.Nullable{System.Int32},System.String,System.Collections.Generic.List{Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.Criterion},Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriteriaLogic,System.Collections.Generic.List{System.Int32},System.Nullable{Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.SortOrder},System.Nullable{System.Int32},Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.HavingCriterion,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Performs the actual aggregation with row iteration.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.DetectFormulaBaseRow(System.String,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Detects the 1-based row number used in a formula expression by finding the first
|
||||||
|
cell reference. Falls back to <paramref name="defaultRow"/> if no reference is found.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.AdjustFormulaRow(System.String,System.Int32,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Adjusts all cell reference row numbers in a formula from one row to another.
|
||||||
|
For example, "J2*K2" with baseRow=2, targetRow=5 becomes "J5*K5".
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.FormatAggregateResults(Telerik.Documents.Spreadsheet.Model.Worksheet,Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregationType,System.Nullable{System.Int32},System.Collections.Generic.List{System.Int32},System.Nullable{Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.SortOrder},System.Nullable{System.Int32},Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.HavingCriterion,System.Collections.Generic.Dictionary{System.String,Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregateState},System.Int32,System.Int32,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Formats aggregation results with HAVING filter, sorting, and limit.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.BuildGroupKey(Telerik.Documents.Spreadsheet.Model.Worksheet,System.Int32,System.Collections.Generic.List{System.Int32})">
|
||||||
|
<summary>
|
||||||
|
Builds a group key from the specified columns.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.FormatNumber(System.Double)">
|
||||||
|
<summary>
|
||||||
|
Formats a number for display (removes unnecessary decimals).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.FormatGetRowsResult(System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.Collections.Generic.List{System.String}},System.Collections.Generic.List{System.Int32},System.Int32,System.Int32,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Formats GetRows results as a readable table.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.TruncateAndPad(System.String,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Truncates string to width and pads with spaces.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.IndexToColumnLetter(System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Converts a 0-based column index to Excel column letter(s).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.GetCellData(Telerik.Documents.Spreadsheet.Model.Worksheet,System.Int32,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Extracts typed cell data: formatted string, raw numeric value, and date flag.
|
||||||
|
Uses the cell's own CellValueFormat for proper display formatting.
|
||||||
|
For numbers, returns the raw double directly (no string round-trip).
|
||||||
|
For dates, sets IsDateTime and stores the OADate in NumericValue.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.GetCellValueAsString(Telerik.Documents.Spreadsheet.Model.Worksheet,System.Int32,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Gets the formatted cell value as a string using the cell's own format.
|
||||||
|
Convenience wrapper around <see cref="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.SpreadProcessingAnalysisTools.GetCellData(Telerik.Documents.Spreadsheet.Model.Worksheet,System.Int32,System.Int32)"/>.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregateState">
|
||||||
|
<summary>
|
||||||
|
Tracks aggregation state for a single group.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregationType">
|
||||||
|
<summary>
|
||||||
|
Specifies the type of aggregation to perform.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregationType.Count">
|
||||||
|
<summary>Count the number of matching rows.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregationType.Sum">
|
||||||
|
<summary>Sum the values in the specified column.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregationType.Average">
|
||||||
|
<summary>Calculate the average of values in the specified column.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregationType.Min">
|
||||||
|
<summary>Find the minimum value in the specified column.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregationType.Max">
|
||||||
|
<summary>Find the maximum value in the specified column.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.AggregationType.CountDistinct">
|
||||||
|
<summary>Count distinct values in the specified column.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriteriaLogic">
|
||||||
|
<summary>
|
||||||
|
Specifies how multiple criteria are combined.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriteriaLogic.And">
|
||||||
|
<summary>All criteria must match (logical AND).</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriteriaLogic.Or">
|
||||||
|
<summary>Any criterion must match (logical OR).</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.SortOrder">
|
||||||
|
<summary>
|
||||||
|
Specifies the sort order for results.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.SortOrder.Ascending">
|
||||||
|
<summary>Sort from smallest to largest.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.SortOrder.Descending">
|
||||||
|
<summary>Sort from largest to smallest.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator">
|
||||||
|
<summary>
|
||||||
|
Specifies the comparison operator for filter criteria.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.Equals">
|
||||||
|
<summary>Cell value equals the criterion value (case-insensitive for text, numeric comparison for numbers).</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.NotEquals">
|
||||||
|
<summary>Cell value does not equal the criterion value.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.GreaterThan">
|
||||||
|
<summary>Cell value is greater than the criterion value (numeric comparison).</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.GreaterThanOrEqual">
|
||||||
|
<summary>Cell value is greater than or equal to the criterion value.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.LessThan">
|
||||||
|
<summary>Cell value is less than the criterion value (numeric comparison).</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.LessThanOrEqual">
|
||||||
|
<summary>Cell value is less than or equal to the criterion value.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.Contains">
|
||||||
|
<summary>Cell value contains the criterion value as a substring (case-insensitive).</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.StartsWith">
|
||||||
|
<summary>Cell value starts with the criterion value (case-insensitive).</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.EndsWith">
|
||||||
|
<summary>Cell value ends with the criterion value (case-insensitive).</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.IsEmpty">
|
||||||
|
<summary>Cell is empty or contains only whitespace.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.IsNotEmpty">
|
||||||
|
<summary>Cell is not empty.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.LengthGreaterThan">
|
||||||
|
<summary>Cell value string length is greater than the criterion integer value.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionOperator.LengthLessThan">
|
||||||
|
<summary>Cell value string length is less than the criterion integer value.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CellData">
|
||||||
|
<summary>
|
||||||
|
Represents extracted cell data with typed values for efficient comparison.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CellData.FormattedValue">
|
||||||
|
<summary>Display string using the cell's own format.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CellData.NumericValue">
|
||||||
|
<summary>Raw numeric value if the cell contains a number (including dates stored as OADate).</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CellData.IsDateTime">
|
||||||
|
<summary>Whether the numeric value represents a date/time based on the cell format.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CellData.IsEmpty">
|
||||||
|
<summary>Whether the cell is empty.</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.Criterion">
|
||||||
|
<summary>
|
||||||
|
Represents a filter criterion for data analysis.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.Criterion.Column">
|
||||||
|
<summary>
|
||||||
|
The column index (0-based) to apply the criterion to.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.Criterion.Operator">
|
||||||
|
<summary>
|
||||||
|
The comparison operator to use for matching.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.Criterion.Value">
|
||||||
|
<summary>
|
||||||
|
The value to compare against.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionMatcher">
|
||||||
|
<summary>
|
||||||
|
Static utility for criterion matching with typed cell data.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionMatcher.Prepare(System.Collections.Generic.List{Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.Criterion})">
|
||||||
|
<summary>
|
||||||
|
Prepares criteria by pre-parsing values (done once, not per-row).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionMatcher.Matches(Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CellData,Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.PreparedCriterion)">
|
||||||
|
<summary>
|
||||||
|
Checks if a cell's typed data matches a prepared criterion.
|
||||||
|
Uses NumericValue directly for numeric comparisons (no string re-parsing).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionMatcher.CheckRow(Telerik.Documents.Spreadsheet.Model.Worksheet,System.Int32,System.Collections.Generic.List{Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.PreparedCriterion},Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriteriaLogic)">
|
||||||
|
<summary>
|
||||||
|
Checks if a row matches all prepared criteria with the specified logic.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.CriterionMatcher.PassesHaving(System.Double,Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.HavingCriterion)">
|
||||||
|
<summary>
|
||||||
|
Checks if an aggregated value passes the HAVING criterion.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.DataRegion">
|
||||||
|
<summary>
|
||||||
|
Represents a detected data region in a worksheet.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.HavingCriterion">
|
||||||
|
<summary>
|
||||||
|
Represents a HAVING filter applied to aggregated results.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.HavingCriterion.Operator">
|
||||||
|
<summary>
|
||||||
|
The comparison operator for the HAVING filter. Valid values: Equals, NotEquals,
|
||||||
|
GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.HavingCriterion.Value">
|
||||||
|
<summary>
|
||||||
|
The numeric value to compare the aggregated result against.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.PreparedCriterion">
|
||||||
|
<summary>
|
||||||
|
Pre-parsed criterion with operator and value parsing done once.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AI.Tools.Spreadsheet.Core.AnalysisModels.PreparedCriterion.DateValue">
|
||||||
|
<summary>Parsed date value when the criterion string represents a date. Used for date-aware cell comparisons.</summary>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
File diff suppressed because it is too large
Load diff
Binary file not shown.
File diff suppressed because it is too large
Load diff
Binary file not shown.
|
|
@ -0,0 +1,298 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Windows.Documents.AIConnector</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.AIConnector.AIProcessorBase">
|
||||||
|
<summary>
|
||||||
|
Abstract base for AI processors that run Q&A and summarization over document text (such as PDF), providing shared configuration and an IDisposable lifecycle for derived processors.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.AIProcessorBase.#ctor(Microsoft.Extensions.AI.IChatClient)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.AIConnector.AIProcessorBase"/> class.
|
||||||
|
</summary>
|
||||||
|
<param name="chatClient">The chat client to be used by the AI processor.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.AIProcessorBase.ChatClient">
|
||||||
|
<summary>
|
||||||
|
Gets the chat client used by the AI processor.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.AIProcessorBase.Dispose">
|
||||||
|
<summary>
|
||||||
|
Releases resources held by the processor, including the underlying chat client.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.AIProcessorBase.CallChatClient(System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Calls the chat client with the specified system prompt and user message.
|
||||||
|
</summary>
|
||||||
|
<param name="systemPrompt">The system prompt to be sent to the chat client.</param>
|
||||||
|
<param name="message">The user message to be sent to the chat client.</param>
|
||||||
|
<returns>A task that represents the asynchronous operation. The task result contains the response message text.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AIConnector.CompleteContextProcessorSettings">
|
||||||
|
<summary>
|
||||||
|
Settings for full-context processing over document text (such as PDF), configuring token limits, encoding, and model selection.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.CompleteContextProcessorSettings.ModelMaxInputTokenLimit">
|
||||||
|
<summary>
|
||||||
|
Gets the maximum input token limit for prompts sent to the model, bounding full-context requests.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.CompleteContextProcessorSettings.TokenizationEncoding">
|
||||||
|
<summary>
|
||||||
|
Gets the tokenization encoding used to measure and split text when preparing prompts.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.CompleteContextProcessorSettings.ModelId">
|
||||||
|
<summary>
|
||||||
|
Gets the model identifier used for AI requests.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.CompleteContextProcessorSettings.ProduceJsonFormattedContext">
|
||||||
|
<summary>
|
||||||
|
Determines whether the context sent to the model is in JSON or plain text format, if json format is applicable.
|
||||||
|
</summary>
|
||||||
|
<remarks>Plain text might consume more tokens but should lead to better results when asking the LLM.</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.CompleteContextProcessorSettings.#ctor(System.Int32,System.String,System.String,System.Boolean)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.AIConnector.CompleteContextProcessorSettings"/> class with the specified maximum input token limit.
|
||||||
|
</summary>
|
||||||
|
<param name="modelMaxInputTokenLimit">The maximum input token limit for the model.</param>
|
||||||
|
<param name="modelId">The model identifier.</param>
|
||||||
|
<param name="tokenizationEncoding">The tokenization encoding the model uses.</param>
|
||||||
|
<param name="produceJsonFormattedContext">Determines whether the context sent to the model will be formatted as json when applicable.</param>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AIConnector.EmbeddingSettingsFactory">
|
||||||
|
<summary>
|
||||||
|
Provides factory methods for creating and configuring embedding settings used in processing text and spread
|
||||||
|
documents with customizable model and tokenization parameters.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.EmbeddingSettingsFactory.CreateSettingsForTextDocuments(System.Int32,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
||||||
|
<summary>
|
||||||
|
Creates and configures settings for processing text documents with specified model and
|
||||||
|
tokenization parameters.
|
||||||
|
</summary>
|
||||||
|
<param name="modelMaxInputTokenLimit">The maximum number of input tokens that the model can accept. Must be a positive integer.</param>
|
||||||
|
<param name="modelId">The identifier of the language model which will be used to process the question. If null, the default model is selected.</param>
|
||||||
|
<param name="tokenizationEncoding">The tokenization encoding scheme used by the model to apply to the text documents. If null, the default encoding is used.</param>
|
||||||
|
<param name="maxNumberOfEmbeddingsIncludedInContext">The maximum number of embeddings to include in the context. If null, no limit is applied.</param>
|
||||||
|
<param name="embeddingTokenSize">The size, in tokens, of each embedding. If null, the default size is used.</param>
|
||||||
|
<returns>An instance of <see cref="T:Telerik.Documents.AI.Core.IEmbeddingSettings"/> configured with the specified parameters for text document
|
||||||
|
processing.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.EmbeddingSettingsFactory.CreateSettingsForSpreadDocuments(System.Int32,System.String,System.String,System.Nullable{System.Int32},System.Boolean,System.Nullable{System.Int32})">
|
||||||
|
<summary>
|
||||||
|
Creates settings configured for processing spread documents with partial context in JSON format.
|
||||||
|
</summary>
|
||||||
|
<param name="modelMaxInputTokenLimit">The maximum number of input tokens supported by the model which will answer the question. Must be a positive integer.</param>
|
||||||
|
<param name="modelId">The identifier of the model which will answer the question. If null, the default model is selected.</param>
|
||||||
|
<param name="tokenizationEncoding">The tokenization encoding scheme to apply when processing input text. If null, the default encoding is used.</param>
|
||||||
|
<param name="embeddingTokenSize">The size, in tokens, of each embedding chunk. If null, the default chunk size is applied.</param>
|
||||||
|
<param name="produceJsonFormattedContext">Specifies whether the context should be formatted as JSON. Set to <see langword="true"/> to produce
|
||||||
|
JSON-formatted context; otherwise, <see langword="false"/> which will produce natural language.</param>
|
||||||
|
<param name="totalContextTokenLimit">The total token limit for the context which will be sent to the answering model. If null, a percentage of the modelMaxInputTokenLimit will be used.</param>
|
||||||
|
<returns>An <see cref="T:Telerik.Documents.AI.Core.IEmbeddingSettings"/> instance configured for spread document processing with the specified
|
||||||
|
parameters.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.JsonSpreadRag.JsonModels.Spread.WorkbookJsonModel.ActiveSheetName">
|
||||||
|
<summary>
|
||||||
|
The name of the active sheet.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.JsonSpreadRag.JsonSpreadContextRetriever.#ctor(Telerik.Documents.AIConnector.JsonSpreadRag.JsonSpreadContextFragmentsManager,Telerik.Documents.AI.Core.IEmbedder,Telerik.Documents.AI.Core.ISimilarityCalculator,Telerik.Documents.AI.Core.ITokensCounter,Telerik.Documents.AI.Core.IEmbeddingSettings)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the DefaultContextRetriever class with the specified context fragments
|
||||||
|
manager, embedder, similarity calculator, tokens counter, and embedding settings.
|
||||||
|
</summary>
|
||||||
|
<param name="contextFragmentsManager">The manager responsible for handling context fragments used in retrieval operations. Cannot be null.</param>
|
||||||
|
<param name="embedder">The component used to generate embeddings for context fragments. Cannot be null.</param>
|
||||||
|
<param name="similarityCalculator">The calculator used to determine similarity between embeddings. Cannot be null.</param>
|
||||||
|
<param name="tokensCounter">The service used to count tokens in context fragments and embeddings. Cannot be null.</param>
|
||||||
|
<param name="settings">The settings that configure embedding parameters, such as the maximum number of embeddings, embedding token
|
||||||
|
size, and model input token limit. Cannot be null.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.JsonSpreadRag.JsonSpreadContextRetriever.GetContextAsync(System.String)">
|
||||||
|
<summary>
|
||||||
|
Gets the text representation of the relevant embeddings for the provided question.
|
||||||
|
</summary>
|
||||||
|
<param name="text">The question text to find relevant context for. Cannot be null.</param>
|
||||||
|
<returns>The text representation of the relevant embeddings.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.JsonSpreadRag.JsonSpreadContextRetriever.SetContextAsync(System.String,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Asynchronously splits the specified text into fragments based on the provided embedding token size.
|
||||||
|
</summary>
|
||||||
|
<param name="text">The text to be divided into fragments. Cannot be null.</param>
|
||||||
|
<param name="embeddingTokenSize">The maximum number of tokens allowed in each fragment. Must be a positive integer.</param>
|
||||||
|
<returns>A task that represents the asynchronous operation of fragmenting the text.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AIConnector.PartialContextProcessorSettings">
|
||||||
|
<summary>
|
||||||
|
Settings for retrieval-augmented (partial context) Q&A over document text (such as PDF), controlling chunking and how many results are sent.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.PartialContextProcessorSettings.MaxNumberOfEmbeddingsIncludedInContext">
|
||||||
|
<summary>
|
||||||
|
Gets how many retrieved chunks are included with the prompt when answering a question, controlling recall and cost.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.PartialContextProcessorSettings.EmbeddingTokenSize">
|
||||||
|
<summary>
|
||||||
|
Gets the token length of each embedding chunk used during retrieval, affecting granularity and relevance.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AIConnector.SummarizationProcessorSettings">
|
||||||
|
<summary>
|
||||||
|
Settings for AI summarization over document text (such as PDF), configuring token limits and prompt customization.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.SummarizationProcessorSettings.PromptAddition">
|
||||||
|
<summary>
|
||||||
|
Gets optional prompt text appended to summarization requests, used for guidance or constraints.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.SummarizationProcessorSettings.#ctor(System.Int32,System.String,System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.AIConnector.SummarizationProcessorSettings"/> class.
|
||||||
|
</summary>
|
||||||
|
<param name="modelMaxInputTokenLimit">The maximum input token limit the model allows.</param>
|
||||||
|
<param name="promptAddition">An addition to the system prompt.</param>
|
||||||
|
<param name="modelId">The model identifier.</param>
|
||||||
|
<param name="tokenizationEncoding">The tokenization encoding the model uses.</param>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AIConnector.CompleteContextQuestionProcessor">
|
||||||
|
<summary>
|
||||||
|
Single-shot Q&A that sends the entire document text to the model; use when the document fits within the model’s input token limit.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.CompleteContextQuestionProcessor.#ctor(Microsoft.Extensions.AI.IChatClient,Telerik.Documents.AIConnector.CompleteContextProcessorSettings)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.AIConnector.CompleteContextQuestionProcessor"/> class.
|
||||||
|
</summary>
|
||||||
|
<param name="chatClient">The chat client to be used for communication with the AI model.</param>
|
||||||
|
<param name="settings">The settings that configure full-context Q&A behavior.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.CompleteContextQuestionProcessor.Settings">
|
||||||
|
<summary>
|
||||||
|
Gets the settings that configure full-context Q&A behavior, including token limits and encoding.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.CompleteContextQuestionProcessor.AnswerQuestion(Telerik.Documents.TextRepresentation.SimpleTextDocument,System.String)">
|
||||||
|
<summary>
|
||||||
|
Generates an answer by prompting the model with the entire document text and the question, up to the configured input token limit.
|
||||||
|
</summary>
|
||||||
|
<param name="document">The document.</param>
|
||||||
|
<param name="question">The question.</param>
|
||||||
|
<returns>The answer to the question.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AIConnector.PartialContextQuestionProcessor">
|
||||||
|
<summary>
|
||||||
|
Retrieval-augmented Q&A that indexes the document into embeddings and fetches the most similar chunks before prompting; use when the document exceeds the model’s input window.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.PartialContextQuestionProcessor.Settings">
|
||||||
|
<summary>
|
||||||
|
Gets the settings that control retrieval-augmented behavior, including chunk size and the number of chunks sent.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.PartialContextQuestionProcessor.#ctor(Microsoft.Extensions.AI.IChatClient,Telerik.Documents.AI.Core.IEmbedder,Telerik.Documents.AI.Core.IEmbeddingSettings,Telerik.Documents.TextRepresentation.SimpleTextDocument)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the PartialContextQuestionProcessor class with the specified chat client,
|
||||||
|
embedder, settings, and document.
|
||||||
|
</summary>
|
||||||
|
<param name="chatClient">The chat client used to communicate with the AI model.</param>
|
||||||
|
<param name="embedder">The embedder responsible for generating vector representations of text fragments for similarity
|
||||||
|
calculations.</param>
|
||||||
|
<param name="settings">The settings that configure partial context processing behavior, such as token limits and retrieval options.</param>
|
||||||
|
<param name="document">The document containing the text to be processed for context retrieval. Cannot be null.</param>
|
||||||
|
<exception cref="T:System.ArgumentNullException">Thrown when the settings parameter is null.</exception>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.PartialContextQuestionProcessor.#ctor(Microsoft.Extensions.AI.IChatClient,Telerik.Documents.AI.Core.IContextRetriever,Telerik.Documents.AI.Core.IEmbeddingSettings,Telerik.Documents.TextRepresentation.SimpleTextDocument)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the PartialContextQuestionProcessor class with the specified chat client,
|
||||||
|
context retriever, context fragments manager, processor settings, and document.
|
||||||
|
</summary>
|
||||||
|
<param name="chatClient">The chat client used to send and receive chat messages within the processing context.</param>
|
||||||
|
<param name="contextRetriever">The context retriever responsible for obtaining relevant context information for question processing.</param>
|
||||||
|
<param name="settings">The settings that configure the behavior of the partial context processor. Cannot be null.</param>
|
||||||
|
<param name="document">The text document that provides the source content for context extraction and processing.</param>
|
||||||
|
<exception cref="T:System.ArgumentNullException">Thrown if the settings parameter is null.</exception>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.PartialContextQuestionProcessor.AnswerQuestion(System.String)">
|
||||||
|
<summary>
|
||||||
|
Generates an answer by retrieving the most relevant embedded chunks for the question and prompting the model.
|
||||||
|
</summary>
|
||||||
|
<param name="question">The question to answer.</param>
|
||||||
|
<returns>A task that represents the asynchronous operation. The task result contains the answer to the question.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.PartialContextQuestionProcessor.Dispose">
|
||||||
|
<summary>
|
||||||
|
Disposes the resources used by the <see cref="T:Telerik.Documents.AIConnector.PartialContextQuestionProcessor"/> class.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AIConnector.SummarizationProcessor">
|
||||||
|
<summary>
|
||||||
|
Generates a concise summary of a document’s text (such as PDF) using full-context prompting up to the configured input token limit.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.SummarizationProcessor.Settings">
|
||||||
|
<summary>
|
||||||
|
Gets the settings that control summarization behavior, including token limits and prompt customization.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.SummarizationProcessor.#ctor(Microsoft.Extensions.AI.IChatClient,Telerik.Documents.AIConnector.SummarizationProcessorSettings)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.AIConnector.SummarizationProcessor"/> class.
|
||||||
|
</summary>
|
||||||
|
<param name="chatClient">The chat client used for communication with the AI service.</param>
|
||||||
|
<param name="settings">The settings of the processor.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.SummarizationProcessor.Summarize(Telerik.Documents.TextRepresentation.SimpleTextDocument)">
|
||||||
|
<summary>
|
||||||
|
Produces a summary of the provided document’s text (such as PDF) using full-context AI prompting, up to the configured input token limit.
|
||||||
|
</summary>
|
||||||
|
<param name="document">The document to be summarized.</param>
|
||||||
|
<returns>A task that represents the asynchronous operation. The task result contains the summarized text.</returns>
|
||||||
|
<exception cref="T:System.OperationCanceledException">Thrown when the summarization operation is cancelled.</exception>
|
||||||
|
</member>
|
||||||
|
<member name="E:Telerik.Documents.AIConnector.SummarizationProcessor.SummaryResourcesCalculated">
|
||||||
|
<summary>
|
||||||
|
Raised when the number of tokens and calls required for summarization have been calculated; provides resource usage details and allows cancellation.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.AIConnector.SummaryResourcesCalculatedEventArgs">
|
||||||
|
<summary>
|
||||||
|
Carries resource estimates for summarizing document text (such as PDF), including call count and token usage, and enables flow control.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.AIConnector.SummaryResourcesCalculatedEventArgs.#ctor(System.Int32,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Creates event data with estimated calls and token counts for summarization over document text (such as PDF).
|
||||||
|
</summary>
|
||||||
|
<param name="estimatedCallsRequired">The estimated number of calls required.</param>
|
||||||
|
<param name="estimatedTokensRequired">The estimated number of tokens required.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.SummaryResourcesCalculatedEventArgs.EstimatedCallsRequired">
|
||||||
|
<summary>
|
||||||
|
Gets the estimated number of model calls needed for summarization, impacting latency and cost.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.SummaryResourcesCalculatedEventArgs.EstimatedTokensRequired">
|
||||||
|
<summary>
|
||||||
|
Gets the estimated input token count for summarization, bounded by the model’s input token limit.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.AIConnector.SummaryResourcesCalculatedEventArgs.ShouldContinueExecution">
|
||||||
|
<summary>
|
||||||
|
Gets or sets whether summarization should proceed based on the resource estimates.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,33 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Windows.Documents.CMapUtils</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.CMapUtils.PredefinedCMapsProvider">
|
||||||
|
<summary>
|
||||||
|
Provides access to predefined CMap resources for mapping character codes in document text (such as PDF), using Adobe’s public character collections.
|
||||||
|
A list with predefined resources can be found on the following repository - https://github.com/adobe-type-tools/cmap-resources.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.CMapUtils.PredefinedCMapsProvider.#ctor">
|
||||||
|
<summary>
|
||||||
|
Create a provider that supplies embedded Adobe CMap resources for mapping character codes when processing documents.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.CMapUtils.PredefinedCMapsProvider.GetCidCMapData(System.String)">
|
||||||
|
<summary>
|
||||||
|
Retrieves the character code to CID mapping for a predefined CMap resource in document text (such as PDF).
|
||||||
|
</summary>
|
||||||
|
<param name="name">The name of the predefined CMap.</param>
|
||||||
|
<returns>The CMap resource data.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.CMapUtils.PredefinedCMapsProvider.GetUnicodeCMapData(System.String)">
|
||||||
|
<summary>
|
||||||
|
Retrieves the character code to Unicode mapping for a predefined CMap resource in document text (such as PDF).
|
||||||
|
</summary>
|
||||||
|
<param name="name">The name of the predefined CMap.</param>
|
||||||
|
<returns>The CMap resource data.</returns>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
File diff suppressed because it is too large
Load diff
Binary file not shown.
File diff suppressed because it is too large
Load diff
Binary file not shown.
|
|
@ -0,0 +1,52 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Windows.Documents.Fixed.FormatProviders.Ocr</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.Fixed.FormatProviders.Ocr.OcrFormatProvider">
|
||||||
|
<summary>
|
||||||
|
Format provider that uses an OCR provider to create a RadFixedPage from an image.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Fixed.FormatProviders.Ocr.OcrFormatProvider.#ctor(Telerik.Documents.Ocr.IOcrProvider)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.Fixed.FormatProviders.Ocr.OcrFormatProvider"/> class.
|
||||||
|
</summary>
|
||||||
|
<param name="ocrProvider">The OCR provider implementation that will be used for optical character recognition operations.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Fixed.FormatProviders.Ocr.OcrFormatProvider.SupportedExtensions">
|
||||||
|
<summary>
|
||||||
|
Gets the supported extensions.
|
||||||
|
</summary>
|
||||||
|
<value>
|
||||||
|
The supported extensions.
|
||||||
|
</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Fixed.FormatProviders.Ocr.OcrFormatProvider.CanImport">
|
||||||
|
<summary>
|
||||||
|
Gets a value indicating whether format provider can import.
|
||||||
|
</summary>
|
||||||
|
<value>The value indicating whether can import.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Fixed.FormatProviders.Ocr.OcrFormatProvider.CanExport">
|
||||||
|
<summary>
|
||||||
|
Gets a value indicating whether format provider can export.
|
||||||
|
</summary>
|
||||||
|
<value>The value indicating whether can export.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Fixed.FormatProviders.Ocr.OcrFormatProvider.OcrProvider">
|
||||||
|
<summary>
|
||||||
|
The OcrProvider instance used to process the image.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Fixed.FormatProviders.Ocr.OcrFormatProvider.ImportOverride(System.IO.Stream,System.Threading.CancellationToken)">
|
||||||
|
<summary>
|
||||||
|
Imports the specified input.
|
||||||
|
</summary>
|
||||||
|
<param name="input">The input stream containing the image data to process with OCR.</param>
|
||||||
|
<param name="cancellationToken">The cancellation token used to cancel the operation.</param>
|
||||||
|
<returns>The imported document.</returns>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
File diff suppressed because it is too large
Load diff
Binary file not shown.
File diff suppressed because it is too large
Load diff
Binary file not shown.
|
|
@ -0,0 +1,146 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Windows.Documents.Flow.FormatProviders.Pdf</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.Flow.FormatProviders.Pdf.Export.NumberingFieldsPrecisionLevel">
|
||||||
|
<summary>
|
||||||
|
Specifies the precision level for updating page numbering fields during PDF export, balancing accuracy against resource usage.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Flow.FormatProviders.Pdf.Export.NumberingFieldsPrecisionLevel.Normal">
|
||||||
|
<summary>
|
||||||
|
Updates numbering fields once without re-measuring layout shifts caused by new values, matching Microsoft Word behavior. Choose High precision if field value changes affect document layout.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Flow.FormatProviders.Pdf.Export.NumberingFieldsPrecisionLevel.High">
|
||||||
|
<summary>
|
||||||
|
Updates numbering fields iteratively until values stabilize with layout re-measurement, ensuring accuracy at the cost of increased processing time and memory.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Flow.FormatProviders.Pdf.Export.PdfExportSettings">
|
||||||
|
<summary>
|
||||||
|
Configures options for exporting flow documents to PDF, including numbering field precision and extensibility hooks for custom formatting.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.Export.PdfExportSettings.#ctor">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.Flow.FormatProviders.Pdf.Export.PdfExportSettings" /> class.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Flow.FormatProviders.Pdf.Export.PdfExportSettings.ExtensibilityManager">
|
||||||
|
<summary>
|
||||||
|
Gets the extensibility manager for registering custom numbering style converters used during PDF export.
|
||||||
|
</summary>
|
||||||
|
<value>The extensibility manager.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Flow.FormatProviders.Pdf.Export.PdfExportSettings.NumberingFieldsPrecision">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the precision level for updating numbering fields, controlling the trade-off between accuracy and performance during PDF export.
|
||||||
|
</summary>
|
||||||
|
<value>The precision level.</value>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.Export.PdfExportSettings.Telerik#Documents#Fixed#FormatProviders#Pdf#ExceptionHandling#IOnExceptionEventRaiser#CanRaiseEvent">
|
||||||
|
<summary>
|
||||||
|
Determines whether the object can raise an exception event.
|
||||||
|
</summary>
|
||||||
|
<returns>True if the object can raise an exception event; otherwise, false.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider">
|
||||||
|
<summary>
|
||||||
|
Exports flow documents to PDF format by converting them to fixed-layout documents; import is not supported.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.#ctor">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider" /> class.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.ExportSettings">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the export settings that control numbering field precision and extensibility options during PDF generation.
|
||||||
|
</summary>
|
||||||
|
<value>The export settings.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.CanExport">
|
||||||
|
<summary>
|
||||||
|
Gets a value indicating whether this format provider can export documents, which is always true for PDF.
|
||||||
|
</summary>
|
||||||
|
<value>The value indicating whether can export.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.CanImport">
|
||||||
|
<summary>
|
||||||
|
Gets a value indicating whether this format provider can import documents, which is always false for PDF.
|
||||||
|
</summary>
|
||||||
|
<value>The value indicating whether can import.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.SupportedExtensions">
|
||||||
|
<summary>
|
||||||
|
Gets the file extensions supported by this provider, which includes .pdf only.
|
||||||
|
</summary>
|
||||||
|
<value>The supported extensions.</value>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.ExportToFixedDocument(Telerik.Documents.Flow.Model.RadFlowDocument,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Converts the flow document to a fixed-layout document with a specified timeout and returns the resulting RadFixedDocument.
|
||||||
|
</summary>
|
||||||
|
<param name="document">The document.</param>
|
||||||
|
<param name="timeout">The timeout after which the operation will be cancelled.</param>
|
||||||
|
<returns>The fixed document.</returns>
|
||||||
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||||
|
The exception that is thrown when timeout is less than -1 or greater than Int32.MaxValue.
|
||||||
|
Note that this upper bound is more restrictive than TimeSpan.MaxValue.
|
||||||
|
</exception>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.ExportOverride(Telerik.Documents.Flow.Model.RadFlowDocument,System.IO.Stream,System.Threading.CancellationToken)">
|
||||||
|
<summary>
|
||||||
|
Exports the specified document.
|
||||||
|
</summary>
|
||||||
|
<param name="document">The document.</param>
|
||||||
|
<param name="output">The output.</param>
|
||||||
|
<param name="cancellationToken">The cancellation token used to cancel the operation.</param>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Flow.FormatProviders.Pdf.Utils.ExtensibilityManager">
|
||||||
|
<summary>
|
||||||
|
Manages extensibility points for PDF export, enabling registration of custom numbering style converters for list formatting.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.Utils.ExtensibilityManager.RegisterNumberingStyleConverter(Telerik.Documents.Flow.Model.Lists.NumberingStyle,Telerik.Documents.Flow.FormatProviders.Pdf.Utils.INumberingStyleConverter)">
|
||||||
|
<summary>
|
||||||
|
Registers a custom converter for the specified numbering style, used to format list item numbers during PDF export.
|
||||||
|
</summary>
|
||||||
|
<param name="numberingStyle">The numbering style.</param>
|
||||||
|
<param name="converter">The converter.</param>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Flow.FormatProviders.Pdf.Utils.INumberingStyleConverter">
|
||||||
|
<summary>
|
||||||
|
Defines a converter that transforms numeric list item values into formatted text for custom numbering styles.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.Utils.INumberingStyleConverter.ConvertNumberToText(System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Converts the specified number to its text representation according to the custom numbering style and returns the formatted string.
|
||||||
|
</summary>
|
||||||
|
<param name="number">The number.</param>
|
||||||
|
<returns>The text representation of the given number.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Flow.FormatProviders.Pdf.NumberingFieldsProvider">
|
||||||
|
<summary>
|
||||||
|
Resolves page numbering field values and bookmark page references for flow documents, supporting custom numbering style converters.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.NumberingFieldsProvider.#ctor">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.Flow.FormatProviders.Pdf.NumberingFieldsProvider" /> class.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.NumberingFieldsProvider.RegisterNumberingStyleConverter(Telerik.Documents.Flow.Model.Lists.NumberingStyle,Telerik.Documents.Flow.FormatProviders.Pdf.Utils.INumberingStyleConverter)">
|
||||||
|
<summary>
|
||||||
|
Registers a custom converter for the specified numbering style, applied when resolving page number field values.
|
||||||
|
</summary>
|
||||||
|
<param name="numberingStyle">The numbering style.</param>
|
||||||
|
<param name="converter">The converter.</param>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
File diff suppressed because it is too large
Load diff
Binary file not shown.
|
|
@ -0,0 +1,216 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.Json.ExtensionMethods">
|
||||||
|
<summary>
|
||||||
|
Provides extension methods working with JSON format.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.Json.ExtensionMethods.ToSimpleTextDocument(Telerik.Documents.Spreadsheet.Model.Workbook,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Converts the specified workbook to a SimpleTextDocument containing its JSON representation.
|
||||||
|
</summary>
|
||||||
|
<param name="workbook">The workbook to convert to a simple text document. Cannot be null.</param>
|
||||||
|
<param name="timeout">An optional timeout that specifies the maximum duration allowed for the export operation. If null, the
|
||||||
|
operation will not be cancelled.</param>
|
||||||
|
<returns>A SimpleTextDocument containing the JSON representation of the workbook.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings">
|
||||||
|
<summary>
|
||||||
|
Provides configuration settings that control how a <see cref="T:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider"/> exports a <see cref="T:Telerik.Documents.Spreadsheet.Model.Workbook"/> to JSON.
|
||||||
|
</summary>
|
||||||
|
<remarks>
|
||||||
|
Unless otherwise noted, all boolean properties default to a value that enables richer output (e.g. number formats, charts, summaries).
|
||||||
|
</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.ExportWhat">
|
||||||
|
<summary>
|
||||||
|
Gets or sets which portion of the workbook will be exported (entire workbook, only the active sheet, or only a selection of ranges).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.IncludeHiddenSheets">
|
||||||
|
<summary>
|
||||||
|
Gets or sets a value indicating whether hidden worksheets are included when <see cref="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.ExportWhat"/> is <see cref="F:Telerik.Documents.Spreadsheet.FormatProviders.ExportWhat.EntireWorkbook"/>.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.IncludeDefinedNames">
|
||||||
|
<summary>
|
||||||
|
Gets or sets a value indicating whether defined names (named ranges / constants) are exported.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.IncludeNumberFormats">
|
||||||
|
<summary>
|
||||||
|
Gets or sets a value indicating whether cell number formats (format codes other than General) are emitted.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.IncludeCharts">
|
||||||
|
<summary>
|
||||||
|
Gets or sets a value indicating whether charts in the exported worksheets are serialized.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.ChartDataMode">
|
||||||
|
<summary>
|
||||||
|
Gets or sets how chart data should be represented (only references, only resolved values, or both).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.PrettyPrint">
|
||||||
|
<summary>
|
||||||
|
Gets or sets a value indicating whether the JSON output should be indented (pretty printed) for readability.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.ValueRenderMode">
|
||||||
|
<summary>
|
||||||
|
Gets or sets how cell values are rendered in the export (raw underlying value, formatted display value, or both).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.IncludeBlankCells">
|
||||||
|
<summary>
|
||||||
|
Gets or sets a value indicating whether blank cells within the used range of a worksheet should be explicitly output.
|
||||||
|
When <c>false</c> blank cells are skipped to reduce JSON size.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.IncludeWorkbookProtectionFlag">
|
||||||
|
<summary>
|
||||||
|
Gets or sets a value indicating whether the workbook protection flag (<see cref="P:Telerik.Documents.Spreadsheet.Model.Workbook.IsProtected"/>) is included.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.IncludeActiveSheet">
|
||||||
|
<summary>
|
||||||
|
Gets or sets a value indicating whether the name of the active worksheet is exported in the metadata section.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.SelectedRanges">
|
||||||
|
<summary>
|
||||||
|
Gets the collection of ranges to export when <see cref="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.ExportWhat"/> is <see cref="F:Telerik.Documents.Spreadsheet.FormatProviders.ExportWhat.Selection"/>.
|
||||||
|
If the collection is empty the active worksheet is exported instead.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.IncludeChartStats">
|
||||||
|
<summary>
|
||||||
|
Gets or sets a value indicating whether per-series statistical aggregates (min, max, average, sum, standard deviation, count) are included for chart data.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.IncludeChartSummaries">
|
||||||
|
<summary>
|
||||||
|
Gets or sets a value indicating whether a human-readable summary string is generated for each chart.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.IncludeChartTrends">
|
||||||
|
<summary>
|
||||||
|
Gets or sets a value indicating whether a simple trend classification (increasing / decreasing / flat) is exported for eligible series.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.Json.ChartDataMode">
|
||||||
|
<summary>
|
||||||
|
Specifies how chart series data should be represented in the exported JSON.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Json.ChartDataMode.ReferencesOnly">
|
||||||
|
<summary>
|
||||||
|
Only the formula / reference expressions are exported; literal value arrays are omitted.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Json.ChartDataMode.ResolvedValues">
|
||||||
|
<summary>
|
||||||
|
Only resolved literal values are exported; formula / reference expressions are omitted.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Json.ChartDataMode.Both">
|
||||||
|
<summary>
|
||||||
|
Both reference expressions and resolved values are exported for each data channel.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.Json.ValueRenderMode">
|
||||||
|
<summary>
|
||||||
|
Specifies which representation(s) of cell values are exported.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Json.ValueRenderMode.Raw">
|
||||||
|
<summary>
|
||||||
|
Export the underlying raw value (e.g. numeric serial date, unformatted number, formula text without its formatted display form).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Json.ValueRenderMode.Display">
|
||||||
|
<summary>
|
||||||
|
Export the formatted display value (e.g. date string, number with applied format, formatted formula result).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Json.ValueRenderMode.Both">
|
||||||
|
<summary>
|
||||||
|
Export both raw and display representations when applicable.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider">
|
||||||
|
<summary>
|
||||||
|
A workbook format provider that exports spreadsheet content to a structured JSON representation.
|
||||||
|
This provider is export-only; importing JSON back into a workbook is not supported.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.#ctor">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider"/> class with default <see cref="T:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings"/>.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.Name">
|
||||||
|
<summary>
|
||||||
|
Gets the provider name.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.FilesDescription">
|
||||||
|
<summary>
|
||||||
|
Gets a human-readable description of the file type handled by this provider.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.SupportedExtensions">
|
||||||
|
<summary>
|
||||||
|
Gets the set of supported file extensions (currently only ".json").
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.CanExport">
|
||||||
|
<summary>
|
||||||
|
Gets a value indicating whether export is supported (always <c>true</c>).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.CanImport">
|
||||||
|
<summary>
|
||||||
|
Gets a value indicating whether import is supported (always <c>false</c> for this provider).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.ExportSettings">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the export settings controlling JSON output. If <c>null</c> at export time, defaults are applied.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.ExportOverride(Telerik.Documents.Spreadsheet.Model.Workbook,System.IO.Stream,System.Threading.CancellationToken)">
|
||||||
|
<summary>
|
||||||
|
Performs the export operation writing a JSON representation of <paramref name="workbook"/> into <paramref name="output"/>.
|
||||||
|
</summary>
|
||||||
|
<param name="workbook">The workbook to export.</param>
|
||||||
|
<param name="output">The destination stream (must be writable).</param>
|
||||||
|
<param name="cancellationToken">Token used to observe cancellation requests.</param>
|
||||||
|
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="workbook"/> or <paramref name="output"/> is <c>null</c>.</exception>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.ImportOverride(System.IO.Stream,System.Threading.CancellationToken)">
|
||||||
|
<summary>
|
||||||
|
Import with cancellation is not supported and always throws <see cref="T:System.NotSupportedException"/>.
|
||||||
|
</summary>
|
||||||
|
<param name="input">The input stream.</param>
|
||||||
|
<param name="cancellationToken">Cancellation token (ignored).</param>
|
||||||
|
<returns>Never returns; always throws.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Json.Serialization.IJsonExportContext.SelectedRanges">
|
||||||
|
<summary>
|
||||||
|
Selection ranges that should be exported when ExportWhat.Selection is used.
|
||||||
|
This will be null for other export modes.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.Json.Serialization.Inspection.CellValueInspector">
|
||||||
|
<summary>
|
||||||
|
Extracts a lightweight value snapshot from a cell without allocating heavy objects.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,167 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsm.XlsmFormatProvider">
|
||||||
|
<summary>
|
||||||
|
Imports and exports workbooks in Excel Macro-Enabled Workbook (.xlsm) format, preserving VBA macros and scripts.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsm.XlsmFormatProvider.#ctor">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsm.XlsmFormatProvider" /> class.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsm.XlsmFormatProvider.Name">
|
||||||
|
<summary>
|
||||||
|
Identifier for this format provider, used for discovery and registration.
|
||||||
|
</summary>
|
||||||
|
<value>The name of the provider.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsm.XlsmFormatProvider.FilesDescription">
|
||||||
|
<summary>
|
||||||
|
Human-readable description of supported files (e.g., "Excel Macro-Enabled Workbook").
|
||||||
|
</summary>
|
||||||
|
<value>The files description.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsm.XlsmFormatProvider.SupportedExtensions">
|
||||||
|
<summary>
|
||||||
|
File extensions recognized by this provider (e.g., ".xlsm").
|
||||||
|
</summary>
|
||||||
|
<value>The supported extensions.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsm.XlsmFormatProvider.CanImport">
|
||||||
|
<summary>
|
||||||
|
Indicates whether this provider supports importing .xlsm files into workbook instances.
|
||||||
|
</summary>
|
||||||
|
<value>The value indicating whether can import.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsm.XlsmFormatProvider.CanExport">
|
||||||
|
<summary>
|
||||||
|
Indicates whether this provider supports exporting workbooks to .xlsm format.
|
||||||
|
</summary>
|
||||||
|
<value>The value indicating whether can export.</value>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsm.XlsmFormatProvider.ImportOverride(System.IO.Stream,System.Threading.CancellationToken)">
|
||||||
|
<summary>
|
||||||
|
Reads an .xlsm file from the stream with cancellation support, constructing a Workbook instance while preserving VBA macros.
|
||||||
|
</summary>
|
||||||
|
<param name="input">The input.</param>
|
||||||
|
<param name="cancellationToken">The cancellation token used to cancel the operation.</param>
|
||||||
|
<returns>The imported workbook.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsm.XlsmFormatProvider.ExportOverride(Telerik.Documents.Spreadsheet.Model.Workbook,System.IO.Stream,System.Threading.CancellationToken)">
|
||||||
|
<summary>
|
||||||
|
Writes the workbook to the stream in .xlsm format with cancellation support, preserving any VBA macros or scripts present.
|
||||||
|
</summary>
|
||||||
|
<param name="workbook">The workbook.</param>
|
||||||
|
<param name="output">The output.</param>
|
||||||
|
<param name="cancellationToken">The cancellation token used to cancel the operation.</param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.Contexts.NoteBase.Text">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the text.
|
||||||
|
</summary>
|
||||||
|
<value>The text value.</value>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.Contexts.GradientInfoType">
|
||||||
|
<summary>
|
||||||
|
Defines gradient info types.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.Contexts.XlsxWorksheetImportContext.ImportShapesSizes">
|
||||||
|
<summary>
|
||||||
|
Imports the shapes sizes from the from cell and to cell.
|
||||||
|
Used in case the shape size is not indicated in the TransformElement.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.Export.XlsxExportSettings">
|
||||||
|
<summary>
|
||||||
|
Configures export options for XLSX format; inherits OpenXML export settings.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.Export.XlsxExportSettings.#ctor">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the XlsxExportSettings class.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.Import.XlsxImportSettings">
|
||||||
|
<summary>
|
||||||
|
Configures import options for XLSX format; inherits OpenXML import settings.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.Import.XlsxImportSettings.#ctor">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the XlsxImportSettings class.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.XlsxFormatProvider">
|
||||||
|
<summary>
|
||||||
|
Imports and exports workbooks in XLSX (Office Open XML) format, supporting full-fidelity roundtrip of spreadsheet data.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.XlsxFormatProvider.#ctor">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.XlsxFormatProvider" /> class.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.XlsxFormatProvider.Name">
|
||||||
|
<summary>
|
||||||
|
Identifies this format provider as "XlsxFormatProvider" for registration and lookup.
|
||||||
|
</summary>
|
||||||
|
<value>The name of the provider.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.XlsxFormatProvider.FilesDescription">
|
||||||
|
<summary>
|
||||||
|
Describes the file type as "Excel Workbook" for display in UI contexts.
|
||||||
|
</summary>
|
||||||
|
<value>The files description.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.XlsxFormatProvider.SupportedExtensions">
|
||||||
|
<summary>
|
||||||
|
Specifies that this provider handles files with .xlsx extension.
|
||||||
|
</summary>
|
||||||
|
<value>The supported extensions.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.XlsxFormatProvider.CanImport">
|
||||||
|
<summary>
|
||||||
|
Indicates that this provider supports importing XLSX files into workbooks.
|
||||||
|
</summary>
|
||||||
|
<value>The value indicating whether can import.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.XlsxFormatProvider.CanExport">
|
||||||
|
<summary>
|
||||||
|
Indicates that this provider supports exporting workbooks to XLSX format.
|
||||||
|
</summary>
|
||||||
|
<value>The value indicating whether can export.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.XlsxFormatProvider.ExportSettings">
|
||||||
|
<summary>
|
||||||
|
Configures XLSX-specific export options; reserved for future extensibility.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.XlsxFormatProvider.ImportSettings">
|
||||||
|
<summary>
|
||||||
|
Configures XLSX-specific import options; reserved for future extensibility.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.XlsxFormatProvider.ImportOverride(System.IO.Stream,System.Threading.CancellationToken)">
|
||||||
|
<summary>
|
||||||
|
Reads XLSX data from the stream and constructs a workbook with optimized formula caching enabled during import.
|
||||||
|
</summary>
|
||||||
|
<param name="input">The input.</param>
|
||||||
|
<param name="cancellationToken">The cancellation token used to cancel the operation.</param>
|
||||||
|
<returns>The imported workbook.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx.XlsxFormatProvider.ExportOverride(Telerik.Documents.Spreadsheet.Model.Workbook,System.IO.Stream,System.Threading.CancellationToken)">
|
||||||
|
<summary>
|
||||||
|
Writes the workbook to the stream in XLSX format with license validation.
|
||||||
|
</summary>
|
||||||
|
<param name="workbook">The workbook.</param>
|
||||||
|
<param name="output">The output.</param>
|
||||||
|
<param name="cancellationToken">The cancellation token used to cancel the operation.</param>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,172 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Windows.Documents.Spreadsheet.FormatProviders.Pdf</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.IPdfChartRenderer">
|
||||||
|
<summary>
|
||||||
|
Defines members for classes which will be used to render charts when exporting a workbook to PDF.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.IPdfChartRenderer.RenderChart(Telerik.Documents.Fixed.Model.Editing.FixedContentEditor,Telerik.Documents.Spreadsheet.Model.Shapes.FloatingChartShape)">
|
||||||
|
<summary>
|
||||||
|
Draws the specified chart onto the PDF page using the fixed content editor for custom chart rendering during export.
|
||||||
|
</summary>
|
||||||
|
<param name="editor">The editor which will render the chart.</param>
|
||||||
|
<param name="chart">The chart to be rendered.</param>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.Layers.WorksheetPredefinedPdfLayers.Gridlines">
|
||||||
|
<summary>
|
||||||
|
The name of the grid lines layer.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.Layers.WorksheetPredefinedPdfLayers.GridlinesOutline">
|
||||||
|
<summary>
|
||||||
|
The name of the grid lines outline layer.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.Layers.WorksheetPredefinedPdfLayers.CellFill">
|
||||||
|
<summary>
|
||||||
|
The name of the cell fill layer.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.Layers.WorksheetPredefinedPdfLayers.CellBorders">
|
||||||
|
<summary>
|
||||||
|
The name of the cell borders layer.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.Layers.WorksheetPredefinedPdfLayers.CellValues">
|
||||||
|
<summary>
|
||||||
|
The name of the cell values layer.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.Layers.WorksheetPredefinedPdfLayers.Shapes">
|
||||||
|
<summary>
|
||||||
|
The name of the shapes layer.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.Layers.WorksheetPredefinedPdfLayers.RowHeadingMargin">
|
||||||
|
<summary>
|
||||||
|
The name of the row heading margin layer.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.Layers.WorksheetPredefinedPdfLayers.ColumnHeadingMargin">
|
||||||
|
<summary>
|
||||||
|
The name of the column heading margin layer.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.Layers.WorksheetPredefinedPdfLayers.HeaderFooter">
|
||||||
|
<summary>
|
||||||
|
The name of the header/footer layer.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.Layers.WorksheetPredefinedPdfLayers.Icons">
|
||||||
|
<summary>
|
||||||
|
The name of the icons layer.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.PdfExportSettings">
|
||||||
|
<summary>
|
||||||
|
Configures which worksheet content to export to PDF and how to render it, including scope, print area handling, and rendering options.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.PdfExportSettings.#ctor(Telerik.Documents.Spreadsheet.FormatProviders.ExportWhat,System.Boolean)">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.PdfExportSettings" /> class.
|
||||||
|
</summary>
|
||||||
|
<param name="exportWhat">The ExportWhat option.</param>
|
||||||
|
<param name="ignorePrintArea">The value indicating whether to ignore print area.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.PdfExportSettings.#ctor(System.Collections.Generic.IEnumerable{Telerik.Documents.Spreadsheet.Model.CellRange})">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.PdfExportSettings" /> class.
|
||||||
|
</summary>
|
||||||
|
<param name="selection">The ranges to export.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.PdfExportSettings.#ctor">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.PdfExportSettings" /> class.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.PdfExportSettings.SelectedRanges">
|
||||||
|
<summary>
|
||||||
|
Specifies the cell ranges to export when ExportWhat is set to Selection.
|
||||||
|
</summary>
|
||||||
|
<value>The selected ranges.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.PdfExportSettings.PdfFileSettings">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the PDF settings used when the <see cref="T:Telerik.Documents.Spreadsheet.Model.Workbook"/> is exported to a file.
|
||||||
|
</summary>
|
||||||
|
<value>The PDF export settings.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.Export.PdfExportSettings.ChartRenderer">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the renderer which will be used to render charts.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.PdfFormatProvider">
|
||||||
|
<summary>
|
||||||
|
Exports workbooks to PDF format by rendering worksheets as paginated documents; import is not supported.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.PdfFormatProvider.#ctor">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the <see cref="T:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.PdfFormatProvider" /> class.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.PdfFormatProvider.Name">
|
||||||
|
<summary>
|
||||||
|
Identifies this format provider as "PdfFormatProvider" for registration and lookup.
|
||||||
|
</summary>
|
||||||
|
<value>The name of the provider.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.PdfFormatProvider.FilesDescription">
|
||||||
|
<summary>
|
||||||
|
Describes the file type as "PDF Documents" for display in UI contexts.
|
||||||
|
</summary>
|
||||||
|
<value>The files description.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.PdfFormatProvider.CanExport">
|
||||||
|
<summary>
|
||||||
|
Indicates that this provider supports exporting workbooks to PDF format.
|
||||||
|
</summary>
|
||||||
|
<value>The value indicating whether can export.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.PdfFormatProvider.CanImport">
|
||||||
|
<summary>
|
||||||
|
Indicates that this provider does not support importing PDF files into workbooks.
|
||||||
|
</summary>
|
||||||
|
<value>The value indicating whether can import.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.PdfFormatProvider.SupportedExtensions">
|
||||||
|
<summary>
|
||||||
|
Specifies that this provider handles files with .pdf extension.
|
||||||
|
</summary>
|
||||||
|
<value>The supported extensions.</value>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.PdfFormatProvider.ExportSettings">
|
||||||
|
<summary>
|
||||||
|
Configures which content to export and how to render worksheets as PDF pages.
|
||||||
|
</summary>
|
||||||
|
<value>The export settings.</value>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.PdfFormatProvider.ExportToFixedDocument(Telerik.Documents.Spreadsheet.Model.Workbook,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Converts the workbook to a RadFixedDocument for further processing or rendering, based on export settings.
|
||||||
|
</summary>
|
||||||
|
<param name="workbook">The workbook.</param>
|
||||||
|
<param name="timeout">The timeout after which the operation will cancel.</param>
|
||||||
|
<returns>The exported fixed document.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Spreadsheet.FormatProviders.Pdf.PdfFormatProvider.ExportOverride(Telerik.Documents.Spreadsheet.Model.Workbook,System.IO.Stream,System.Threading.CancellationToken)">
|
||||||
|
<summary>
|
||||||
|
Writes the workbook content to the stream as a PDF document, respecting export settings for scope and rendering options.
|
||||||
|
</summary>
|
||||||
|
<param name="workbook">The workbook to export.</param>
|
||||||
|
<param name="output">The output.</param>
|
||||||
|
<param name="cancellationToken">The cancellation token used to cancel the operation.</param>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
File diff suppressed because it is too large
Load diff
Binary file not shown.
File diff suppressed because it is too large
Load diff
Binary file not shown.
File diff suppressed because it is too large
Load diff
Binary file not shown.
|
|
@ -0,0 +1,342 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Windows.Zip.Extensions</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="T:Telerik.Zip.Extensions.DotNetPlatformManager">
|
||||||
|
<summary>
|
||||||
|
Platform manager which can be used with full version of the .NET Framework.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.DotNetPlatformManager.#ctor">
|
||||||
|
<summary>
|
||||||
|
Initializes a new instance of the DotNetPlatformManager class.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Zip.Extensions.DotNetPlatformManager.AltDirectorySeparatorChar">
|
||||||
|
<summary>
|
||||||
|
Gets a platform-specific alternate character used to separate directory levels in a path string that reflects a hierarchical file system organization.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Zip.Extensions.DotNetPlatformManager.DefaultEncoding">
|
||||||
|
<summary>
|
||||||
|
Gets default encoding for this platform.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Zip.Extensions.DotNetPlatformManager.DirectorySeparatorChar">
|
||||||
|
<summary>
|
||||||
|
Gets a platform-specific character used to separate directory levels in a path string that reflects a hierarchical file system organization.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Zip.Extensions.DotNetPlatformManager.TemporaryStreamType">
|
||||||
|
<summary>
|
||||||
|
Gets or sets type of the temporary stream. The default value is TemporaryStreamType.Memory.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.DotNetPlatformManager.CreateTemporaryStream">
|
||||||
|
<summary>
|
||||||
|
Creates temporary stream.
|
||||||
|
</summary>
|
||||||
|
<returns>Stream will be used for temporary operations.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.DotNetPlatformManager.DeleteTemporaryStream(System.IO.Stream)">
|
||||||
|
<summary>
|
||||||
|
Deletes temporary stream.
|
||||||
|
</summary>
|
||||||
|
<param name="stream">Stream to delete.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.DotNetPlatformManager.GetCryptoProvider(Telerik.Zip.EncryptionSettingsBase)">
|
||||||
|
<summary>
|
||||||
|
Gets crypto provider initialized using given encryption settings.
|
||||||
|
</summary>
|
||||||
|
<param name="settings">Encryption settings.</param>
|
||||||
|
<returns>Crypto provider.</returns>
|
||||||
|
<exception cref="T:System.NotSupportedException">Specified crypto algorithm is not supported.</exception>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.DotNetPlatformManager.GetCryptoStream(Telerik.Zip.EncryptionSettingsBase,System.IO.Stream,Telerik.Zip.StreamOperationMode,Telerik.Zip.ICryptoProvider,Telerik.Zip.CompressionSettings)">
|
||||||
|
<summary>
|
||||||
|
Gets crypto stream initialized using given encryption settings.
|
||||||
|
</summary>
|
||||||
|
<param name="encryptionSettings">Encryption settings.</param>
|
||||||
|
<param name="baseStream">Stream.</param>
|
||||||
|
<param name="mode">Stream operation mode.</param>
|
||||||
|
<param name="cryptoProvider">Crypto provider.</param>
|
||||||
|
<param name="compressionSettings">Compression settings.</param>
|
||||||
|
<returns>Crypto stream.</returns>
|
||||||
|
<exception cref="T:System.NotSupportedException">Specified crypto algorithm is not supported.</exception>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.DotNetPlatformManager.IsEncodingSupported(System.Text.Encoding)">
|
||||||
|
<summary>
|
||||||
|
Indicates whether specified encoding is supported for this platform.
|
||||||
|
</summary>
|
||||||
|
<param name="encoding">Encoding.</param>
|
||||||
|
<returns>true if encoding is allowed in the ZIP file.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Zip.Extensions.TemporaryStreamType">
|
||||||
|
<summary>
|
||||||
|
Type of the temporary stream.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Zip.Extensions.TemporaryStreamType.File">
|
||||||
|
<summary>
|
||||||
|
The temporary stream represents temporary file in the file system.
|
||||||
|
</summary>
|
||||||
|
<remarks>It allows manipulations with large archives and minimize memory consumption.</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="F:Telerik.Zip.Extensions.TemporaryStreamType.Memory">
|
||||||
|
<summary>
|
||||||
|
The temporary stream represents data in the memory.
|
||||||
|
</summary>
|
||||||
|
<remarks>It is the fastest way of the data manipulation.</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Zip.Extensions.ZipFile">
|
||||||
|
<summary>
|
||||||
|
Provides static methods for creating, extracting, and opening zip archives.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.CreateEntryFromFile(Telerik.Zip.ZipArchive,System.String,System.String,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Archives a file by compressing it and adding it to the zip archive.
|
||||||
|
</summary>
|
||||||
|
<param name="destination">The zip archive to add the file to.</param>
|
||||||
|
<param name="sourceFileName">The path to the file to be archived. You can specify either a relative or an absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="entryName">The name of the entry to create in the zip archive.</param>
|
||||||
|
<param name="timeout">The time period after which the operation will be cancelled.</param>
|
||||||
|
<returns>New entry in archive.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.CreateEntryFromFile(Telerik.Zip.ZipArchive,System.String,System.String,Telerik.Zip.CompressionLevel,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Archives a file by compressing it using the specified compression level and adding it to the zip archive.
|
||||||
|
</summary>
|
||||||
|
<param name="destination">The zip archive to add the file to.</param>
|
||||||
|
<param name="sourceFileName">The path to the file to be archived. You can specify either a relative or an absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="entryName">The name of the entry to create in the zip archive.</param>
|
||||||
|
<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>
|
||||||
|
<param name="timeout">The time period after which the operation will be cancelled.</param>
|
||||||
|
<returns>New entry in archive.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.CreateEntryFromFile(Telerik.Zip.ZipArchive,System.String,System.String,Telerik.Zip.CompressionSettings,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Archives a file by compressing it using the specified compression settings and adding it to the zip archive.
|
||||||
|
</summary>
|
||||||
|
<param name="destination">The zip archive to add the file to.</param>
|
||||||
|
<param name="sourceFileName">The path to the file to be archived. You can specify either a relative or an absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="entryName">The name of the entry to create in the zip archive.</param>
|
||||||
|
<param name="compressionSettings">Compression settings.</param>
|
||||||
|
<param name="timeout">The time period after which the operation will be cancelled.</param>
|
||||||
|
<returns>New entry in archive.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Creates a zip archive that contains the files and directories from the specified directory.
|
||||||
|
</summary>
|
||||||
|
<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="destinationArchiveFileName">The path of the archive to be created, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="timeout">The time period after which the operation will be cancelled.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,Telerik.Zip.CompressionLevel,System.Boolean,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Creates a zip archive that contains the files and directories from the specified directory, uses the specified compression level, and optionally includes the base directory.
|
||||||
|
</summary>
|
||||||
|
<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="destinationArchiveFileName">The path of the archive to be created, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>
|
||||||
|
<param name="includeBaseDirectory">True to include the directory name from sourceDirectoryName at the root of the archive; false to include only the contents of the directory.</param>
|
||||||
|
<param name="timeout">The time period after which the operation will be cancelled.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,Telerik.Zip.CompressionLevel,System.Boolean,System.Text.Encoding,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Creates a zip archive that contains the files and directories from the specified directory, uses the specified compression level, and optionally includes the base directory.
|
||||||
|
</summary>
|
||||||
|
<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="destinationArchiveFileName">The path of the archive to be created, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="compressionLevel">One of the enumeration values that indicates whether to emphasize speed or compression effectiveness when creating the entry.</param>
|
||||||
|
<param name="includeBaseDirectory">True to include the directory name from sourceDirectoryName at the root of the archive; false to include only the contents of the directory.</param>
|
||||||
|
<param name="entryNameEncoding">The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names.</param>
|
||||||
|
<param name="timeout">The time period after which the operation will be cancelled.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,Telerik.Zip.CompressionSettings,System.Boolean,System.Text.Encoding,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Creates a zip archive that contains the files and directories from the specified directory, uses the specified compression settings, and optionally includes the base directory.
|
||||||
|
</summary>
|
||||||
|
<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="destinationArchiveFileName">The path of the archive to be created, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="compressionSettings">Compression settings.</param>
|
||||||
|
<param name="includeBaseDirectory">True to include the directory name from sourceDirectoryName at the root of the archive; false to include only the contents of the directory.</param>
|
||||||
|
<param name="entryNameEncoding">The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names.</param>
|
||||||
|
<param name="timeout">The time period after which the operation will be cancelled.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.CreateFromDirectory(System.String,System.String,Telerik.Zip.CompressionSettings,System.Boolean,System.Text.Encoding,System.Threading.CancellationToken)">
|
||||||
|
<summary>
|
||||||
|
Creates a zip archive that contains the files and directories from the specified directory, uses the specified compression settings, and optionally includes the base directory.
|
||||||
|
</summary>
|
||||||
|
<param name="sourceDirectoryName">The path to the directory to be archived, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="destinationArchiveFileName">The path of the archive to be created, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="compressionSettings">Compression settings.</param>
|
||||||
|
<param name="includeBaseDirectory">True to include the directory name from sourceDirectoryName at the root of the archive; false to include only the contents of the directory.</param>
|
||||||
|
<param name="entryNameEncoding">The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names.</param>
|
||||||
|
<param name="cancellationToken">The cancellation token used to cancel the operation.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.ExtractToDirectory(System.String,System.String,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Extracts all the files in the specified zip archive to a directory on the file system.
|
||||||
|
</summary>
|
||||||
|
<param name="sourceArchiveFileName">The path to the archive that is to be extracted.</param>
|
||||||
|
<param name="destinationDirectoryName">The path to the directory in which to place the extracted files,
|
||||||
|
specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="timeout">The time period after which the operation will be cancelled.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.ExtractToDirectory(System.String,System.String,System.Text.Encoding,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Extracts all the files in the specified zip archive to a directory on the file system and uses the specified character encoding for entry names.
|
||||||
|
</summary>
|
||||||
|
<param name="sourceArchiveFileName">The path to the archive that is to be extracted.</param>
|
||||||
|
<param name="destinationDirectoryName">The path to the directory in which to place the extracted files,
|
||||||
|
specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="entryNameEncoding">The encoding to use when reading or writing entry names in this archive.
|
||||||
|
Specify a value for this parameter only when an encoding is required for interoperability with zip archive
|
||||||
|
tools and libraries that do not support UTF-8 encoding for entry names.</param>
|
||||||
|
<param name="timeout">The time period after which the operation will be cancelled.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.ExtractToDirectory(Telerik.Zip.ZipArchive,System.String,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Extracts all the files in the zip archive to a directory on the file system.
|
||||||
|
</summary>
|
||||||
|
<param name="source">The zip archive to extract files from.</param>
|
||||||
|
<param name="destinationDirectoryName">The path to the directory to place the extracted files in. You can specify either a relative or an absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="timeout">The time period after which the operation will be cancelled.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.ExtractToFile(Telerik.Zip.ZipArchiveEntry,System.String,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Extracts an entry in the zip archive to a file.
|
||||||
|
</summary>
|
||||||
|
<param name="source">The zip archive entry to extract a file from.</param>
|
||||||
|
<param name="destinationFileName">The path of the file to create from the contents
|
||||||
|
of the entry. You can specify either a relative or an absolute path. A relative path
|
||||||
|
is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="timeout">The time period after which the operation will be cancelled.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.ExtractToFile(Telerik.Zip.ZipArchiveEntry,System.String,System.Boolean,System.Nullable{System.TimeSpan})">
|
||||||
|
<summary>
|
||||||
|
Extracts an entry in the zip archive to a file, and optionally overwrites an existing file that has the same name.
|
||||||
|
</summary>
|
||||||
|
<param name="source">The zip archive entry to extract a file from.</param>
|
||||||
|
<param name="destinationFileName">The path of the file to create from the contents
|
||||||
|
of the entry. You can specify either a relative or an absolute path. A relative path
|
||||||
|
is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="overwrite">True to overwrite an existing file that has the same name as the destination file; otherwise, false.</param>
|
||||||
|
<param name="timeout">The time period after which the operation will be cancelled.</param>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.Open(System.String,Telerik.Zip.ZipArchiveMode)">
|
||||||
|
<summary>
|
||||||
|
Opens a zip archive at the specified path and in the specified mode.
|
||||||
|
</summary>
|
||||||
|
<param name="archiveFileName">The path to the archive to open, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="mode">One of the enumeration values that specifies the actions which are allowed on the entries in the opened archive.</param>
|
||||||
|
<returns>The opened zip archive.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.Open(System.String,Telerik.Zip.ZipArchiveMode,System.Text.Encoding)">
|
||||||
|
<summary>
|
||||||
|
Opens a zip archive at the specified path and in the specified mode.
|
||||||
|
</summary>
|
||||||
|
<param name="archiveFileName">The path to the archive to open, specified as a relative or absolute path. A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<param name="mode">One of the enumeration values that specifies the actions which are allowed on the entries in the opened archive.</param>
|
||||||
|
<param name="entryNameEncoding">The encoding to use when reading or writing entry names in this archive. Specify a value for this parameter only when an encoding is required for interoperability with zip archive tools and libraries that do not support UTF-8 encoding for entry names.</param>
|
||||||
|
<returns>The opened zip archive.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.OpenRead(System.String)">
|
||||||
|
<summary>
|
||||||
|
Opens a zip archive for reading at the specified path.
|
||||||
|
</summary>
|
||||||
|
<param name="archiveFileName">The path to the archive to open, specified as a relative or absolute path.
|
||||||
|
A relative path is interpreted as relative to the current working directory.</param>
|
||||||
|
<returns>The opened zip archive.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Zip.Extensions.ZipFile.IsDirectoryEmpty(System.IO.DirectoryInfo)">
|
||||||
|
<summary>
|
||||||
|
Indicates whether specified directory is empty or not.
|
||||||
|
</summary>
|
||||||
|
<param name="directoryInfo">Directory info.</param>
|
||||||
|
<returns>True if directory is empty; otherwise - false.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.ResolvePath(System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||||||
|
<summary>
|
||||||
|
Resolves a path to a document applying extension, traversal and (Windows-only) UNC validations.
|
||||||
|
</summary>
|
||||||
|
<param name="basePath">Base directory (relative or absolute).</param>
|
||||||
|
<param name="documentPath">User-supplied path (relative, absolute, or UNC).</param>
|
||||||
|
<param name="allowedNetworkHosts">UNC host/share allow-list (Windows only). Null or empty denies all UNC paths.</param>
|
||||||
|
<returns>Full path if valid; otherwise null.</returns>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.ResolveCandidatePath(System.String,System.String,System.Boolean,System.Collections.Generic.IEnumerable{System.String})">
|
||||||
|
<summary>
|
||||||
|
Returns the candidate resolved path (absolute or UNC) without performing an existence check.
|
||||||
|
Applies validation logic if enabled. Intended strictly for internal testing of resolution semantics.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.ResolvePathNoValidation(System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Lightweight resolution when document path validation is disabled.
|
||||||
|
Combines base + relative if needed and returns the candidate path (existence checked centrally in ResolvePath).
|
||||||
|
Skips UNC allow-list and traversal containment checks.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.ResolvePathWithValidation(System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||||||
|
<summary>
|
||||||
|
Performs secure resolution of a document path:
|
||||||
|
1) Determines effective absolute path (respecting UNC vs local semantics).
|
||||||
|
2) If UNC, verifies host/share is explicitly allowed before any filesystem call.
|
||||||
|
3) Normalizes paths and enforces containment within base (or allowed UNC root).
|
||||||
|
4) Returns path only if the target file exists.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.BuildEffectivePath(System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Produces an absolute candidate path unless already rooted. UNC paths are considered rooted.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.IsNetworkPath(System.String)">
|
||||||
|
<summary>
|
||||||
|
Returns true for Windows UNC patterns (\\server, \\?\UNC\server). Non-Windows platforms return false.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.NormalizeForComparison(System.String)">
|
||||||
|
<summary>
|
||||||
|
Normalizes path for comparison: trims; on Windows converts '/' to '\\' and collapses redundant leading backslashes.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.IsAllowedNetworkPath(System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||||||
|
<summary>
|
||||||
|
Assumes networkPath is already confirmed as a network/UNC path. Returns true if it begins with any canonical allow-list prefix.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.CanonicalizeAllowedPrefix(System.String)">
|
||||||
|
<summary>
|
||||||
|
Converts an allow-list entry to canonical form: \\host\\share\\ (ensures leading/trailing backslashes).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.GetAllowedNetworkRoot(System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||||||
|
<summary>
|
||||||
|
Returns the longest canonical allow-list prefix that matches the UNC path; null if no match.
|
||||||
|
Assumes entries in allowedNetworkHosts are already canonical ("\\\\host\\share\\").
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.PrecomputeCanonicalAllowList(System.Collections.Generic.IEnumerable{System.String})">
|
||||||
|
<summary>
|
||||||
|
Precomputes a distinct set of canonical UNC prefixes from a raw allow-list.
|
||||||
|
Returns an empty array if source is null or no valid entries.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.IsWindows">
|
||||||
|
<summary>
|
||||||
|
Platform check for Windows.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Documents.Utilities.PathValidationUtils.CollapseUncRelativeSegments(System.String,System.String)">
|
||||||
|
<summary>
|
||||||
|
Collapses '.' and '..' segments in a UNC path after the allowed root prefix.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
Binary file not shown.
File diff suppressed because it is too large
Load diff
BIN
lib/RCAJAX/2026.3.812.462/Telerik.Licensing.Runtime.dll
Normal file
BIN
lib/RCAJAX/2026.3.812.462/Telerik.Licensing.Runtime.dll
Normal file
Binary file not shown.
BIN
lib/RCAJAX/2026.3.812.462/Telerik.Web.Design.dll
Normal file
BIN
lib/RCAJAX/2026.3.812.462/Telerik.Web.Design.dll
Normal file
Binary file not shown.
BIN
lib/RCAJAX/2026.3.812.462/Telerik.Web.Device.Detection.dll
Normal file
BIN
lib/RCAJAX/2026.3.812.462/Telerik.Web.Device.Detection.dll
Normal file
Binary file not shown.
137
lib/RCAJAX/2026.3.812.462/Telerik.Web.Device.Detection.xml
Normal file
137
lib/RCAJAX/2026.3.812.462/Telerik.Web.Device.Detection.xml
Normal file
|
|
@ -0,0 +1,137 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<doc>
|
||||||
|
<assembly>
|
||||||
|
<name>Telerik.Web.Device.Detection</name>
|
||||||
|
</assembly>
|
||||||
|
<members>
|
||||||
|
<member name="M:Telerik.Web.Device.Detection.Detector.GetScreenDimensions(System.String)">
|
||||||
|
<summary>
|
||||||
|
Returns the screens dimensions of the device made request in CSS pixels. If there is no match the dimensions will be 0.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Web.Device.Detection.Detector.GetScreenSize(System.String)">
|
||||||
|
<summary>
|
||||||
|
Returns the screens size based on default screen ranges (in CSS pixels).
|
||||||
|
</summary>
|
||||||
|
<remarks>
|
||||||
|
The default ranges are:
|
||||||
|
Small (to 600) CSS pixels
|
||||||
|
Medium (601-1024) CSS pixels
|
||||||
|
Large (1025 - 1366) CSS pixels
|
||||||
|
ExtraLarge (over 1366) CSS pixels
|
||||||
|
</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Web.Device.Detection.Detector.GetScreenSize(System.String,Telerik.Web.Device.Detection.ScreenRanges)">
|
||||||
|
<summary>
|
||||||
|
Returns the screens size based on custom screen ranges (in CSS pixels).
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Web.Device.Detection.DeviceModelData">
|
||||||
|
<summary>
|
||||||
|
Used to serialize/deserialize the data about the devices - model and dimensions
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Web.Device.Detection.DeviceScreenDimensions">
|
||||||
|
<summary>
|
||||||
|
Contains the device dimensions in CSS pixels
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Web.Device.Detection.DeviceScreenDimensions.#ctor">
|
||||||
|
<summary>
|
||||||
|
Default constructor of the DeviceScreenDimensions
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Web.Device.Detection.DeviceScreenDimensions.Width">
|
||||||
|
<summary>
|
||||||
|
Gets the device width in CSS pixels.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Web.Device.Detection.DeviceScreenDimensions.Height">
|
||||||
|
<summary>
|
||||||
|
Gets the device height in CSS pixels.
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Web.Device.Detection.DeviceScreenSize">
|
||||||
|
<summary>
|
||||||
|
The device screen size based on the its dimensions in CSS pixels
|
||||||
|
</summary>
|
||||||
|
<remarks>
|
||||||
|
The default ranges are:
|
||||||
|
Small (to 600) CSS pixels
|
||||||
|
Medium (601-1024) CSS pixels
|
||||||
|
Large (1025 - 1366) CSS pixels
|
||||||
|
ExtraLarge (over 1366) CSS pixels
|
||||||
|
</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Web.Device.Detection.ScreenRange">
|
||||||
|
<summary>
|
||||||
|
Used to define custom range
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Web.Device.Detection.ScreenRange.#ctor(System.Int32,System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Constructor of the ScreenRange class. The overload params are assigned to the public properties
|
||||||
|
</summary>
|
||||||
|
<param name="minimum"></param>
|
||||||
|
<param name="maximum"></param>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Web.Device.Detection.ScreenRange.Minimum">
|
||||||
|
<summary>
|
||||||
|
Minimum value of the range
|
||||||
|
</summary>
|
||||||
|
<remarks>
|
||||||
|
The values should considered as CSS pixels not as a standard ones
|
||||||
|
</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Web.Device.Detection.ScreenRange.Maximum">
|
||||||
|
<summary>
|
||||||
|
Maximum value of the range
|
||||||
|
</summary>
|
||||||
|
<remarks>
|
||||||
|
The values should considered as CSS pixels not as a standard ones
|
||||||
|
</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="M:Telerik.Web.Device.Detection.ScreenRange.ContainsValue(System.Int32)">
|
||||||
|
<summary>
|
||||||
|
Determines if the provided value is inside the range
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="T:Telerik.Web.Device.Detection.ScreenRanges">
|
||||||
|
<summary>
|
||||||
|
ScreenRanges is used to define custom ranges
|
||||||
|
</summary>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Web.Device.Detection.ScreenRanges.ExtraLargeScreenSizeRange">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the extra large screen range
|
||||||
|
</summary>
|
||||||
|
<remarks>
|
||||||
|
The range should considered in CSS pixels not as a standard ones
|
||||||
|
</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Web.Device.Detection.ScreenRanges.LargeScreenSizeRange">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the large screen range
|
||||||
|
</summary>
|
||||||
|
<remarks>
|
||||||
|
The range should considered in CSS pixels not as a standard ones
|
||||||
|
</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Web.Device.Detection.ScreenRanges.MediumScreenSizeRange">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the medium screen range
|
||||||
|
</summary>
|
||||||
|
<remarks>
|
||||||
|
The range should considered in CSS pixels not as a standard ones
|
||||||
|
</remarks>
|
||||||
|
</member>
|
||||||
|
<member name="P:Telerik.Web.Device.Detection.ScreenRanges.SmallScreenSizeRange">
|
||||||
|
<summary>
|
||||||
|
Gets or sets the small screen range
|
||||||
|
</summary>
|
||||||
|
<remarks>
|
||||||
|
The range should considered in CSS pixels not as a standard ones
|
||||||
|
</remarks>
|
||||||
|
</member>
|
||||||
|
</members>
|
||||||
|
</doc>
|
||||||
BIN
lib/RCAJAX/2026.3.812.462/Telerik.Web.UI.Skins.dll
Normal file
BIN
lib/RCAJAX/2026.3.812.462/Telerik.Web.UI.Skins.dll
Normal file
Binary file not shown.
196448
lib/RCAJAX/2026.3.812.462/Telerik.Web.UI.XML
Normal file
196448
lib/RCAJAX/2026.3.812.462/Telerik.Web.UI.XML
Normal file
File diff suppressed because it is too large
Load diff
BIN
lib/RCAJAX/2026.3.812.462/Telerik.Web.UI.dll
Normal file
BIN
lib/RCAJAX/2026.3.812.462/Telerik.Web.UI.dll
Normal file
Binary file not shown.
7
lib/RCAJAX/2026.3.812.462/distribution.xml
Normal file
7
lib/RCAJAX/2026.3.812.462/distribution.xml
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<Distribution xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
||||||
|
<Version>2026.3.812.462</Version>
|
||||||
|
<Dependencies>
|
||||||
|
<Project>5099a83b-4c18-45e6-8548-b59036cb28cc</Project>
|
||||||
|
</Dependencies>
|
||||||
|
</Distribution>
|
||||||
Loading…
Add table
Reference in a new issue