# SharpDocx

**Repository Path**: workingbird/SharpDocx

## Basic Information

- **Project Name**: SharpDocx
- **Description**: 使用类似Razor为模板引擎的Word模板
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-10-27
- **Last Updated**: 2025-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SharpDocx
[![NuGet](https://img.shields.io/nuget/v/SharpDocx.svg)](https://www.nuget.org/packages/SharpDocx/)
[![MIT](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/egonl/SharpDocx/blob/master/LICENSE)
[![AppVeyor](https://img.shields.io/appveyor/ci/egonl/SharpDocx.svg)](https://ci.appveyor.com/project/egonl/SharpDocx/branch/master)

*Lightweight template engine for creating Word documents*

Generating documents with SharpDocx is a two step process. First you create a view in Word. A view is a Word document which also contains C# code. Code can be inserted anywhere, e.g. <%= DateTime.Now %> would insert the current date and time.

The next step is to create documents based on this view. This requires two lines of code:
```c#
var document = DocumentFactory.Create("view.cs.docx");
document.Generate("output.docx");
```

Out of the box SharpDocx supports inserting text, tables, images and more. See the Tutorial sample (here's the [view](https://github.com/egonl/SharpDocx/raw/master/Samples/Views/Tutorial.cs.docx) and the [controller](https://github.com/egonl/SharpDocx/blob/master/Samples/SampleProjects/Tutorial/Program.cs), and here's the [generated document](https://github.com/egonl/SharpDocx/raw/master/Samples/Documents/Tutorial.docx)).

If you want, you can specify a view model to be used in your view. Then you could write things like <% foreach (var item in Model.MyList) { %>. 
```c#
var document = DocumentFactory.Create("view.cs.docx", myModel);
document.Generate("output.docx", myModel);
```
See also the Model sample.

If you want to do something that's not supported by SharpDocx, you can do so by creating your own document subclass. See the Inheritance example.

SharpDocx supports .NET Framework 3.5-4.8 and .NET Standard 2.0. Since it supports .NET Standard 2.0 it can be used in .NET Core 3.1, .NET 5.0 and .NET 6.0 projects as well.