ClassDelimitedValuesFormatProviderBase
Base class for text-based workbook format providers that handle delimited value formats like CSV and tab-delimited files, providing common import and export functionality.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.FormatProviders.TextBased
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public abstract class DelimitedValuesFormatProviderBase : TextBasedWorkbookFormatProviderBase, ITextBasedWorkbookFormatProvider, IWorkbookFormatProviderInheritance: objectWorkbookFormatProviderBaseTextBasedWorkbookFormatProviderBaseDelimitedValuesFormatProviderBase
Derived Classes:
Implements:
Inherited Members
Constructors
DelimitedValuesFormatProviderBase()
Initializes a new instance of the DelimitedValuesFormatProviderBase class with TrimLeadingEmptyRowsAndColumns set to true.
Declaration
protected DelimitedValuesFormatProviderBase()Properties
CanExport
Gets a value indicating whether this provider supports exporting workbooks to delimited text format, always returning true.
Declaration
public override bool CanExport { get; }Property Value
The value indicating whether can export.
Overrides
CanImport
Gets a value indicating whether this provider supports importing delimited text files, always returning true.
Declaration
public override bool CanImport { get; }Property Value
The value indicating whether can import.
Overrides
Settings
Gets the configuration settings controlling delimiter, quote, encoding, and header behavior for delimited text import and export.
Declaration
public abstract CsvSettings Settings { get; }Property Value
The settings.
TrimLeadingEmptyRowsAndColumns
Gets or sets a value indicating whether empty rows and columns at the start of the worksheet are excluded from export, defaulting to true to minimize file size.
Declaration
public bool TrimLeadingEmptyRowsAndColumns { get; set; }Property Value
The value indicating whether the leading empty rows and columns should be trimmed.
Methods
ExportOverride(Workbook, Stream)
Serializes the active worksheet to delimited text format, applying cell formatting to generate text representations of cell values.
ExportOverride(Workbook, Stream, CancellationToken)
Serializes the active worksheet to delimited text format with cancellation support, applying cell formatting to generate text representations of cell values.
Declaration
protected override void ExportOverride(Workbook workbook, Stream output, CancellationToken cancellationToken)Parameters
workbook
The workbook.
output
The output.
cancellationToken
The token used to cancel the operation.
Overrides
ImportOverride(Stream)
Parses delimited text from the input stream and returns a workbook with cell values and formatting inferred from the text data.
ImportOverride(Stream, CancellationToken)
Parses delimited text from the input stream with cancellation support and returns a workbook with cell values and formatting inferred from the text data.
Declaration
protected override Workbook ImportOverride(Stream input, CancellationToken cancellationToken)Parameters
input
The input.
cancellationToken
The token used to cancel the operation.
Returns
The imported workbook.
Overrides