Class ExcelImportEngine

Inheritance
System.Object
ImportEngine
ExcelImportEngine
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: TimeCockpit.Data.Import.Excel
Assembly: TimeCockpit.Data.Import.dll
Syntax
public class ExcelImportEngine : ImportEngine

Constructors

ExcelImportEngine(DataContext)

Declaration
public ExcelImportEngine(DataContext dataContext)
Parameters
Type Name Description
DataContext dataContext

Properties

CurrentRowCount

Declaration
public override int CurrentRowCount { get; }
Property Value
Type Description
System.Int32
Overrides

SourceWorkbook

Declaration
public XLWorkbook SourceWorkbook { get; }
Property Value
Type Description
ClosedXML.Excel.XLWorkbook

Methods

FetchUpdateKeys(ImportColumnDefinition[], ModelEntityBase, Int32)

Declaration
protected override Dictionary<int, string> FetchUpdateKeys(ImportColumnDefinition[] keyColumns, ModelEntityBase targetEntity, int defaultHeaderRowNumber = 1)
Parameters
Type Name Description
ImportColumnDefinition[] keyColumns
ModelEntityBase targetEntity
System.Int32 defaultHeaderRowNumber
Returns
Type Description
System.Collections.Generic.Dictionary<System.Int32, System.String>
Overrides

GetCellKeyValue(ImportColumnDefinition)

Declaration
public override object GetCellKeyValue(ImportColumnDefinition column)
Parameters
Type Name Description
ImportColumnDefinition column
Returns
Type Description
System.Object
Overrides

GetCellValue(ImportColumnDefinition)

Declaration
public override object GetCellValue(ImportColumnDefinition column)
Parameters
Type Name Description
ImportColumnDefinition column
Returns
Type Description
System.Object
Overrides

GetCellValueBoolean(Object, out Boolean)

Declaration
protected override bool GetCellValueBoolean(object cellValue, out bool b)
Parameters
Type Name Description
System.Object cellValue
System.Boolean b
Returns
Type Description
System.Boolean
Overrides

GetCellValueDateTime(Object, out DateTime)

Declaration
protected override bool GetCellValueDateTime(object cellValue, out DateTime dt)
Parameters
Type Name Description
System.Object cellValue
System.DateTime dt
Returns
Type Description
System.Boolean
Overrides

GetCellValueDecimal(Object, out Decimal)

Declaration
protected override bool GetCellValueDecimal(object cellValue, out decimal d)
Parameters
Type Name Description
System.Object cellValue
System.Decimal d
Returns
Type Description
System.Boolean
Overrides

GetCellValueGuid(Object, out Guid)

Declaration
protected override bool GetCellValueGuid(object cellValue, out Guid g)
Parameters
Type Name Description
System.Object cellValue
System.Guid g
Returns
Type Description
System.Boolean
Overrides

GetCellValueString(Object, out String)

Declaration
protected override bool GetCellValueString(object cellValue, out string s)
Parameters
Type Name Description
System.Object cellValue
System.String s
Returns
Type Description
System.Boolean
Overrides

GetReportData()

Declaration
public override byte[] GetReportData()
Returns
Type Description
System.Byte[]
Overrides

GetReportMetadata(String, DateTime, out String, out String)

Declaration
public override void GetReportMetadata(string definitionName, DateTime exportTimestamp, out string filename, out string mimeType)
Parameters
Type Name Description
System.String definitionName
System.DateTime exportTimestamp
System.String filename
System.String mimeType
Overrides

GetSourceMetadata(out String, out String)

Declaration
public override void GetSourceMetadata(out string filename, out string mimeType)
Parameters
Type Name Description
System.String filename
System.String mimeType
Overrides

HasMoreRows()

Declaration
public override bool HasMoreRows()
Returns
Type Description
System.Boolean
Overrides

IsCellEmpty(Object)

Declaration
protected override bool IsCellEmpty(object cellValue)
Parameters
Type Name Description
System.Object cellValue
Returns
Type Description
System.Boolean
Overrides

LoadPreviewData(Int32, Byte[], Dictionary<String, Int32>, Int32)

Declaration
public override PreviewWorkbook LoadPreviewData(int sampleSize, byte[] sourceData, Dictionary<string, int> headerRowNumbers = null, int defaultHeaderRowNumber = 1)
Parameters
Type Name Description
System.Int32 sampleSize
System.Byte[] sourceData
System.Collections.Generic.Dictionary<System.String, System.Int32> headerRowNumbers
System.Int32 defaultHeaderRowNumber
Returns
Type Description
PreviewWorkbook
Overrides

MoveToNextRow()

Declaration
public override void MoveToNextRow()
Overrides

PrepareImportSheet(ImportSheetDefinition)

Declaration
public override bool PrepareImportSheet(ImportSheetDefinition sheetDefinition)
Parameters
Type Name Description
ImportSheetDefinition sheetDefinition
Returns
Type Description
System.Boolean
Overrides

PrepareImportWorkbook(ImportBookDefinition)

Declaration
public override bool PrepareImportWorkbook(ImportBookDefinition book)
Parameters
Type Name Description
ImportBookDefinition book
Returns
Type Description
System.Boolean
Overrides

SavePreviewData(PreviewWorkbook)

Declaration
public override byte[] SavePreviewData(PreviewWorkbook previewWorkbook)
Parameters
Type Name Description
PreviewWorkbook previewWorkbook
Returns
Type Description
System.Byte[]
Overrides

SetRowMessage(ImportSheetDefinition, String, Boolean, Boolean)

Declaration
public override void SetRowMessage(ImportSheetDefinition sheetDefinition, string text, bool isError, bool isModification)
Parameters
Type Name Description
ImportSheetDefinition sheetDefinition
System.String text
System.Boolean isError
System.Boolean isModification
Overrides