Zt-freak/Apodemus.NPOI.XWPFMapper

A library for mapping objects to Word document tables with the NPOI library.

NPOI.XWPFMapper

This is a library for mapping objects to Word document tables with the NPOI library.

Usage

You can take a look at the NPOI.XWPFMapper.Example project for a working example.

NPOI.XWPFMapper uses the interface IXWPFMappable and the attribute XWPFPropertyAttribute to define which classes should be mappable and which members should be nested or just strings.

internal class ExampleClass : IXWPFMappable // Implement the IXWPFMappable interface to make a class mappable
{
    public XWPFTableAlignment XWPFTableAlignment { get; set; }

    // Add the XWPFPropertyattribute to make a member mappable.
    [XWPFProperty("Color")] 
    public ExampleEnum Enum { get; set; }

    [XWPFProperty("Name")]
    public string Name { get; set; }

    // This child class also implements IXWPFMappable and will become a nested table.
    [XWPFProperty("Address", XWPFTableAlignment.Column)]
    public ExampleChildClass Address { get; set; }

    // Without the XWPFPropertyAttribute a member will be ignored by the mapping.
    public string IgnoredMember { get; set; }
}

internal class ExampleChildClass : IXWPFMappable
{
    public XWPFTableAlignment XWPFTableAlignment { get; set; }

    [XWPFProperty("Street")]
    public string Address { get; set; }
    [XWPFProperty("Place")]
    public string City { get; set; }
    [XWPFProperty("Country")]
    public string CountryCode { get; set; }
}

In addition to this, there is also the XWPFTableWrapper, which is a class that manages an XWPFTable. It only accepts a single Type to be mapped (excluding its members of course).

XWPFDocument document = new XWPFDocument();

ExampleClass exampleData = new ExampleClass()
{
    Enum = ExampleEnum.Red,
    Name = "This is a test",
    IgnoredMember = "This member will be ignored",
    Address = new ExampleChildClass()
    {
        Address = "Burgemeester Schönfeldplein",
        City = "Winschoten",
        CountryCode = "NL"
    }
};

// XWPFTableWrapper requires a Type argument and an XWPFDocument object to work
// In addition you can optionally set the direction of the table with an enum XWPFTableAlignment (default is Row)

XWPFTableWrapper<ExampleClass> wrapper = new XWPFTableWrapper<ExampleClass>(document, XWPFTableAlignment.Column);
wrapper.Insert(exampleData);

XWPFTableWrapper's XWPFTable is public, so you can access it from XWPFTableWrapper.

Table alignment

Table alignment for nested tables can be set at different points, they are prioritised in the followng order:

• at the XWPFPropertyAttribute
• at XWPFTableAlignment of the nested object that implements IXWPFMappable
• inherited from a parent's XWPFTableAlignment

XWPFTableAlignment.Row

Color	Name	Address
Red	This is a test	Van Nelleweg 1, Rotterdam

XWPFTableAlignment.Column

Color	Red
Name	This is a test
Address	Van Nelleweg 1, Rotterdam

🏳️‍⚧️ Trans Rights are human rights!