eDosStation/lib/RCWPF/2026.3.812.462/Telerik.Windows.Documents.Flow.FormatProviders.Pdf.xml

147 lines
8.8 KiB
XML
Raw Permalink Normal View History

2026-07-28 16:36:22 +02:00
<?xml version="1.0"?>
<doc>
<assembly>
<name>Telerik.Windows.Documents.Flow.FormatProviders.Pdf</name>
</assembly>
<members>
2026-08-17 12:14:32 +02:00
<member name="T:Telerik.Documents.Flow.FormatProviders.Pdf.Export.NumberingFieldsPrecisionLevel">
2026-07-28 16:36:22 +02:00
<summary>
Specifies the precision level for updating page numbering fields during PDF export, balancing accuracy against resource usage.
</summary>
</member>
2026-08-17 12:14:32 +02:00
<member name="F:Telerik.Documents.Flow.FormatProviders.Pdf.Export.NumberingFieldsPrecisionLevel.Normal">
2026-07-28 16:36:22 +02:00
<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>
2026-08-17 12:14:32 +02:00
<member name="F:Telerik.Documents.Flow.FormatProviders.Pdf.Export.NumberingFieldsPrecisionLevel.High">
2026-07-28 16:36:22 +02:00
<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>
2026-08-17 12:14:32 +02:00
<member name="T:Telerik.Documents.Flow.FormatProviders.Pdf.Export.PdfExportSettings">
2026-07-28 16:36:22 +02:00
<summary>
Configures options for exporting flow documents to PDF, including numbering field precision and extensibility hooks for custom formatting.
</summary>
</member>
2026-08-17 12:14:32 +02:00
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.Export.PdfExportSettings.#ctor">
2026-07-28 16:36:22 +02:00
<summary>
2026-08-17 12:14:32 +02:00
Initializes a new instance of the <see cref="T:Telerik.Documents.Flow.FormatProviders.Pdf.Export.PdfExportSettings" /> class.
2026-07-28 16:36:22 +02:00
</summary>
</member>
2026-08-17 12:14:32 +02:00
<member name="P:Telerik.Documents.Flow.FormatProviders.Pdf.Export.PdfExportSettings.ExtensibilityManager">
2026-07-28 16:36:22 +02:00
<summary>
Gets the extensibility manager for registering custom numbering style converters used during PDF export.
</summary>
<value>The extensibility manager.</value>
</member>
2026-08-17 12:14:32 +02:00
<member name="P:Telerik.Documents.Flow.FormatProviders.Pdf.Export.PdfExportSettings.NumberingFieldsPrecision">
2026-07-28 16:36:22 +02:00
<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>
2026-08-17 12:14:32 +02:00
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.Export.PdfExportSettings.Telerik#Documents#Fixed#FormatProviders#Pdf#ExceptionHandling#IOnExceptionEventRaiser#CanRaiseEvent">
2026-07-28 16:36:22 +02:00
<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>
2026-08-17 12:14:32 +02:00
<member name="T:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider">
2026-07-28 16:36:22 +02:00
<summary>
Exports flow documents to PDF format by converting them to fixed-layout documents; import is not supported.
</summary>
</member>
2026-08-17 12:14:32 +02:00
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.#ctor">
2026-07-28 16:36:22 +02:00
<summary>
2026-08-17 12:14:32 +02:00
Initializes a new instance of the <see cref="T:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider" /> class.
2026-07-28 16:36:22 +02:00
</summary>
</member>
2026-08-17 12:14:32 +02:00
<member name="P:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.ExportSettings">
2026-07-28 16:36:22 +02:00
<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>
2026-08-17 12:14:32 +02:00
<member name="P:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.CanExport">
2026-07-28 16:36:22 +02:00
<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>
2026-08-17 12:14:32 +02:00
<member name="P:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.CanImport">
2026-07-28 16:36:22 +02:00
<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>
2026-08-17 12:14:32 +02:00
<member name="P:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.SupportedExtensions">
2026-07-28 16:36:22 +02:00
<summary>
Gets the file extensions supported by this provider, which includes .pdf only.
</summary>
<value>The supported extensions.</value>
</member>
2026-08-17 12:14:32 +02:00
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.ExportToFixedDocument(Telerik.Documents.Flow.Model.RadFlowDocument,System.Nullable{System.TimeSpan})">
2026-07-28 16:36:22 +02:00
<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>
2026-08-17 12:14:32 +02:00
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.PdfFormatProvider.ExportOverride(Telerik.Documents.Flow.Model.RadFlowDocument,System.IO.Stream,System.Threading.CancellationToken)">
2026-07-28 16:36:22 +02:00
<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>
2026-08-17 12:14:32 +02:00
<member name="T:Telerik.Documents.Flow.FormatProviders.Pdf.Utils.ExtensibilityManager">
2026-07-28 16:36:22 +02:00
<summary>
Manages extensibility points for PDF export, enabling registration of custom numbering style converters for list formatting.
</summary>
</member>
2026-08-17 12:14:32 +02:00
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.Utils.ExtensibilityManager.RegisterNumberingStyleConverter(Telerik.Documents.Flow.Model.Lists.NumberingStyle,Telerik.Documents.Flow.FormatProviders.Pdf.Utils.INumberingStyleConverter)">
2026-07-28 16:36:22 +02:00
<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>
2026-08-17 12:14:32 +02:00
<member name="T:Telerik.Documents.Flow.FormatProviders.Pdf.Utils.INumberingStyleConverter">
2026-07-28 16:36:22 +02:00
<summary>
Defines a converter that transforms numeric list item values into formatted text for custom numbering styles.
</summary>
</member>
2026-08-17 12:14:32 +02:00
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.Utils.INumberingStyleConverter.ConvertNumberToText(System.Int32)">
2026-07-28 16:36:22 +02:00
<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>
2026-08-17 12:14:32 +02:00
<member name="T:Telerik.Documents.Flow.FormatProviders.Pdf.NumberingFieldsProvider">
2026-07-28 16:36:22 +02:00
<summary>
Resolves page numbering field values and bookmark page references for flow documents, supporting custom numbering style converters.
</summary>
</member>
2026-08-17 12:14:32 +02:00
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.NumberingFieldsProvider.#ctor">
2026-07-28 16:36:22 +02:00
<summary>
2026-08-17 12:14:32 +02:00
Initializes a new instance of the <see cref="T:Telerik.Documents.Flow.FormatProviders.Pdf.NumberingFieldsProvider" /> class.
2026-07-28 16:36:22 +02:00
</summary>
</member>
2026-08-17 12:14:32 +02:00
<member name="M:Telerik.Documents.Flow.FormatProviders.Pdf.NumberingFieldsProvider.RegisterNumberingStyleConverter(Telerik.Documents.Flow.Model.Lists.NumberingStyle,Telerik.Documents.Flow.FormatProviders.Pdf.Utils.INumberingStyleConverter)">
2026-07-28 16:36:22 +02:00
<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>