Class
DataTableFormatProviderImportSettings

Configures import behavior from DataTable to worksheet, including header handling, date formatting, and start position.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.FormatProviders

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition
public class DataTableFormatProviderImportSettings

Inheritance: objectDataTableFormatProviderImportSettings

Constructors

DataTableFormatProviderImportSettings()

Initializes a new instance of the DataTableFormatProviderImportSettings class with default settings.

Declaration

cs-api-definition
public DataTableFormatProviderImportSettings()

Properties

PreferredDateTimeFormat

Gets or sets the format string applied to imported DateTime columns; when null, uses the current culture's short date pattern.

Declaration

cs-api-definition
public string PreferredDateTimeFormat { get; set; }

Property Value

string

ShouldImportColumnHeaders

Gets or sets whether DataTable column names should be imported as the first row in the worksheet; defaults to true.

Declaration

cs-api-definition
public bool ShouldImportColumnHeaders { get; set; }

Property Value

bool

StartCellIndex

Gets or sets the cell index where the imported data begins in the worksheet; defaults to (0,0).

Declaration

cs-api-definition
public CellIndex StartCellIndex { get; set; }

Property Value

CellIndex

Methods

OnCellImported(int, int, int, int, Worksheet)

Raises the CellImported event for the specified cell.

Declaration

cs-api-definition
protected virtual void OnCellImported(int dataTableRowIndex, int dataTableColumnIndex, int worksheetRowIndex, int worksheetColumnIndex, Worksheet worksheet)

Parameters

dataTableRowIndex

int

The index of the row in the DataTable containing the cell that the event occurs for.

dataTableColumnIndex

int

The index of the column in the DataTable containing the cell that the event occurs for.

worksheetRowIndex

int

The index of the row in the Worksheet containing the cell that the event occurs for.

worksheetColumnIndex

int

The index of the column in the Worksheet containing the cell that the event occurs for.

worksheet

Worksheet

The worksheet where the data is imported.

Events

CellImported

Raised after each cell is imported, allowing customization of cell properties in the destination worksheet.

Declaration

cs-api-definition
public event EventHandler<CellImportedEventArgs> CellImported

Event Value

EventHandler<CellImportedEventArgs>