Class DataTableFormatProviderImportSettings

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

Inheritance
System.Object
DataTableFormatProviderImportSettings
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.FormatProviders
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class DataTableFormatProviderImportSettings

Constructors

DataTableFormatProviderImportSettings()

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

Declaration
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
public string PreferredDateTimeFormat { get; set; }
Property Value
System.String

ShouldImportColumnHeaders

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

Declaration
public bool ShouldImportColumnHeaders { get; set; }
Property Value
System.Boolean

StartCellIndex

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

Declaration
public CellIndex StartCellIndex { get; set; }
Property Value
CellIndex

Methods

OnCellImported(Int32, Int32, Int32, Int32, Worksheet)

Raises the CellImported event for the specified cell.

Declaration
protected virtual void OnCellImported(int dataTableRowIndex, int dataTableColumnIndex, int worksheetRowIndex, int worksheetColumnIndex, Worksheet worksheet)
Parameters
System.Int32 dataTableRowIndex

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

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

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

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
public event EventHandler<CellImportedEventArgs> CellImported
Event Type
System.EventHandler<CellImportedEventArgs>