Skip to content

Latest commit

 

History

History
108 lines (89 loc) · 5.38 KB

README.md

File metadata and controls

108 lines (89 loc) · 5.38 KB
Raw

OpenXmlEx

Installation: Install-Package OpenXmlEx -Version 2.0.2.0

ENG

Оболочка для OpenXML, призванная облегчить запись тяжёлых документов без выделения большого количества памяти

1 Создайте стили для документа

    var styles = new OpenXmlExStyles(
        new List<BaseOpenXmlExStyle>()
        {
            new BaseOpenXmlExStyle() {FontColor = System.Drawing.Color.Crimson, IsBoldFont = true},
            new BaseOpenXmlExStyle() {FontSize = 20, FontName = "Calibri", BorderColor = System.Drawing.Color.Red}
        });

Но не забывайте что все ваши стили будут идти с номерами по порядку после двух стандартных стилей

далее вы можете проводить поиск необходимых стилей если забыли номер или сомневаетесь

    var (key, value) = writer.FindStyleOrDefault(
        new BaseOpenXmlExStyle()
        {
            FontColor = System.Drawing.Color.Crimson,
            FontSize = 20,
            IsBoldFont = true,
            LeftBorderStyle = BorderStyleValues.Dashed,
            RightBorderStyle = BorderStyleValues.Dashed
        });

Где key - номер стиля

2 Создайте новый EasyWriter

    using var writer = new EasyWriter(FileName, styles);

3 Добавьте новый лист

    var sheet_name_1 = "Test_sheet_name";
    writer.AddNewSheet(sheet_name_1);

4 Укажите способ группировки строк (если необходимо)

(устанавливается 1 раз на лист)

    writer.SetGrouping(false, false); // SetGrouping(bool SummaryBelow = false, bool SummaryRight = false)

5 Укажите размеры колонок

(устанавливается 1 раз на лист)

    var width_setting = new List<WidthOpenXmlEx>
    {
        new (1, 2, 7),
        new (3, 3, 11),
        new (4, 12, 9.5),
        new (13, 13, 17),
        new (14, 14, 40),
        new (15, 16, 15),
        new (18, 20, 15)
    };
    writer.SetWidth(width_setting); //SetWidth(IEnumerable<WidthOpenXmlEx> settings)

6 Добавьте строку

    writer.AddRow(3, 0, true, true);
    //AddRow(uint RowIndex, uint CollapsedLvl = 0, bool ClosePreviousIfOpen = false, bool AddSkipedRows = false)
    //CloseRow(uint RowNumber)

CollapsedLvl - устанавливает уровень группировки для строк (вложенность), поумолчанию - 0 (без группировки)

Используйте ClosePreviousIfOpen Если хотите автоматически закрывать строку при создании новой, если параметр не указан и добавлена новая строка до того как закрыта текущая - будет ошибка записи.

Используйте CloseRow если нужен полный контроль за данными;

используйте AddSkipedRows, или вручную добавляйте пропущенные строки. XML не поддерживает пропуска строк, данные должны начинаться с 1 строки, после нее должна идти вторая и так далее.

7 Добавьте ячейку

    writer.AddCell("Test", 1, 3, 0);
    //AddCell(string text, uint CellNum, uint RowNum, uint StyleIndex = 0, CellValues Type = CellValues.String, bool CanReWrite = false)

StyleIndex - номер стиля из таблицы которую создали вначале, но если вы не помните номер используйте FindStyleOrDefault, и не забывайте что ваши стили будут начнаться с номера 2

CanReWrite - перезапись данных в ячейке может вызвать сбой в документе, используйте этот параметр чтобы отключить вызов ошибки;

8 Установите объединенные диапазоны ячеек

Установить диапазон как объединённый можно в любом месте после зодания листа и до закрытия или создания нового

    writer.MergeCells(6, 3, 10, 5); //MergeCells(int StartCell, int StartRow, int EndCell, int EndRow)

9 Установите фильтр

Установите фильтр таблицы если он необходим, вызвать функцию можно в любом месте после содания листа и до закрытия или создания нового, но только 1 раз на лист!

    writer.SetFilter(1, 5, 3, 5); //SetFilter(string ListName, uint FirstColumn, uint LastColumn, uint FirstRow, uint LastRow)

10 Закройте Writer или добавьте новый лист и повторите шаги

Writer добавит все необходимые закрывающие теги когда будет вызван Close, Dispose, или начат новый лист документа.