eDosStationFull/lib/RCWPF/2026.2.701.462/Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json.xml

217 lines
13 KiB
XML
Raw Permalink Normal View History

2026-08-18 12:15:26 +02:00
<?xml version="1.0"?>
<doc>
<assembly>
<name>Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json</name>
</assembly>
<members>
<member name="T:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json.ExtensionMethods">
<summary>
Provides extension methods working with JSON format.
</summary>
</member>
<member name="M:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json.ExtensionMethods.ToSimpleTextDocument(Telerik.Windows.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.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings">
<summary>
Provides configuration settings that control how a <see cref="T:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider"/> exports a <see cref="T:Telerik.Windows.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.Windows.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.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.IncludeHiddenSheets">
<summary>
Gets or sets a value indicating whether hidden worksheets are included when <see cref="P:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.ExportWhat"/> is <see cref="F:Telerik.Windows.Documents.Spreadsheet.FormatProviders.ExportWhat.EntireWorkbook"/>.
</summary>
</member>
<member name="P:Telerik.Windows.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.Windows.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.Windows.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.Windows.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.Windows.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.Windows.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.Windows.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.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.IncludeWorkbookProtectionFlag">
<summary>
Gets or sets a value indicating whether the workbook protection flag (<see cref="P:Telerik.Windows.Documents.Spreadsheet.Model.Workbook.IsProtected"/>) is included.
</summary>
</member>
<member name="P:Telerik.Windows.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.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.SelectedRanges">
<summary>
Gets the collection of ranges to export when <see cref="P:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings.ExportWhat"/> is <see cref="F:Telerik.Windows.Documents.Spreadsheet.FormatProviders.ExportWhat.Selection"/>.
If the collection is empty the active worksheet is exported instead.
</summary>
</member>
<member name="P:Telerik.Windows.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.Windows.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.Windows.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.Windows.Documents.Spreadsheet.FormatProviders.Json.ChartDataMode">
<summary>
Specifies how chart series data should be represented in the exported JSON.
</summary>
</member>
<member name="F:Telerik.Windows.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.Windows.Documents.Spreadsheet.FormatProviders.Json.ChartDataMode.ResolvedValues">
<summary>
Only resolved literal values are exported; formula / reference expressions are omitted.
</summary>
</member>
<member name="F:Telerik.Windows.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.Windows.Documents.Spreadsheet.FormatProviders.Json.ValueRenderMode">
<summary>
Specifies which representation(s) of cell values are exported.
</summary>
</member>
<member name="F:Telerik.Windows.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.Windows.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.Windows.Documents.Spreadsheet.FormatProviders.Json.ValueRenderMode.Both">
<summary>
Export both raw and display representations when applicable.
</summary>
</member>
<member name="T:Telerik.Windows.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.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider"/> class with default <see cref="T:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonExportSettings"/>.
</summary>
</member>
<member name="P:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.Name">
<summary>
Gets the provider name.
</summary>
</member>
<member name="P:Telerik.Windows.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.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.SupportedExtensions">
<summary>
Gets the set of supported file extensions (currently only ".json").
</summary>
</member>
<member name="P:Telerik.Windows.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.Windows.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.Windows.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.Windows.Documents.Spreadsheet.FormatProviders.Json.JsonFormatProvider.ExportOverride(Telerik.Windows.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.Windows.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.Windows.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.Windows.Documents.Spreadsheet.FormatProviders.Json.Serialization.Inspection.CellValueInspector">
<summary>
Extracts a lightweight value snapshot from a cell without allocating heavy objects.
</summary>
</member>
</members>
</doc>