# ExcelImportKit

**Repository Path**: frankwei/ExcelImportKit

## Basic Information

- **Project Name**: ExcelImportKit
- **Description**: 导入excel的类库。使用xml映射C#类和导入模板，可以很轻松地应对模板的修改。
- **Primary Language**: C#
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2020-08-04
- **Last Updated**: 2021-11-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ExcelImportKit
import excel data(.xlsx file) with epplus by an easy way

## Overview

### Support
.Net Framework 4.5+

### Get Started

1. add *ErrorMessage.cfg.xml* and *ExcelImport.cfg.xml* to *Configs* folder under root directory of project 

2. map importing class fields to *ExcelImport.cfg.xml*

C# class, import class should inherit *ImportEntityBase*
```C#
    public class SampleImport : ImportEntityBase
    {
        public SampleImport()
        { }

        public int Age { get; set; }
        public string Name { get; set; }
        public DateTime Birthday { get; set; }
        public float Height { get; set; }
        public decimal Money { get; set; }
        public bool Gender { get; set; }
        public string GenderName => Gender ? "Male" : "Female";
        /// <summary>
        /// 1: Student  2: Staff 3: Soldier
        /// </summary>
        public int State { get; set; }
        public string StateName { get { return State == 1 ? "Student" : State == 2 ? "Staff" : State == 3 ? "Soldier" : "not set"; } }
    }

```

cfg.xml
```xml
  <!--sheet and column index both start by 1-->
  <Sample dataStartRow="2" sheetIndex="1" entity="ModelImport.SampleImport, ModelImport" checkEndCol="1">
    <column name="Age" property="Age" col="1" type="System.Int32" required="true" regexp="\d+" />
    <column name="Name" property="Name" col="2" type="System.String" required="true" />
    <column name="Birthday" property="Birthday" col="3" type="System.Nullable`1[[System.DateTime]]" />
    <column name="Height" property="Height" col="4" type="System.Single" required="true" />
    <column name="Money" property="Money" col="5" type="System.Decimal" required="true" />
    <column name="Gender" property="Gender" col="6" type="System.String" valuemapping="true" valuetype="System.Boolean">
      <!--mapping keys should be upper case-->
      <mappings>
        <!--default value-->
        <mapping key="" value="false"/>
        <mapping key="MALE" value="true"/>
        <mapping key="FEMALE" value="false"/>
      </mappings>
    </column>
    <column name="State" property="State" col="7" type="System.String" valuemapping="true" valuetype="System.Int32">
      <!--mapping keys should be upper case-->
      <mappings>
        <!--default value-->
        <mapping key="" value="0"/>
        <mapping key="STUDENT" value="1"/>
        <mapping key="STAFF" value="2"/>
        <mapping key="SOLDIER" value="3"/>
      </mappings>
    </column>
  </Sample> 
```
    node name "Sample" can be any word you like, and all can put multi nodes in cfg file.

3. use it as simple as sample below:

```C#
    IList<ImportError> errors = new List<ImportError>();
    IList<SampleImport> importList;
    var filePath = RootDirectoryHelper.GetFilePath("./Excels/sampleImport.xlsx");
    var cfgNodeName = "Sample";

    using (var fs = new FileStream(filePath, FileMode.Open))
    {
        importList = new ExcelImportService<SampleImport>().GetParsedPositionImport(fs, errors, cfgNodeName);
    } 
```

4. *ErrorMessage.cfg.xml* contains general errors in it. you can custom them of course.