Экспорт¶

Контрол DataGrid поддерживает экспорт данных в следующие форматы:

XLSX (Microsoft Excel)
PDF
CSV
Форматы изображений (PNG, JPEG, SVG и WebP)

Note

Экспорт данных в форматы XLSX, PDF и изображения реализован в библиотеке Eremex.DocumentProcessing. Убедитесь, что эта библиотека подключена к вашему проекту для использования функции экспорта.

Экспорт в формат XLSX¶

Механизм экспорта в Excel учитывает структуру данных и сохраняет в выходном XLSX-документе настройки формирования данных грида, включая:

Группировку строк
Форматирование значений
Сортировку данных

После экспорта данные можно обрабатывать и анализировать в Microsoft Excel или другом приложении для работы с электронными таблицами.

Note

Форматирование ячеек, реализованное с помощью шаблонов ячеек (GridColumn.CellTemplate), не экспортируется.

Используйте следующие методы для экспорта данных контрола в формат XLSX:

DataGridControl.ExportToXlsx(string fileName, XlsxExportOptions? options = null) — экспортирует данные в файл.
DataGridControl.ExportToXlsx(Stream stream, XlsxExportOptions? options = null) — экспортирует данные в поток.

Необязательный параметр options (типа XlsxExportOptions) позволяет настроить параметры экспорта. Класс XlsxExportOptions предоставляет следующие члены:

Событие ExportProgress — возникает многократно в процессе экспорта данных. Параметр ExportProgressEventArgs.ProgressPercentage этого события указывает прогресс в процентах (от 0 до 100). Вы можете использовать это событие для отображения пользователям хода экспорта в удобном виде.
Свойство AllowFixedColumnHeaderPanel (по умолчанию true) — определяет, остаётся ли панель заголовков колонок закреплённой сверху в экспортированном документе.
ApplyFormattingToEntireColumn — определяет, применяется ли форматирование ячеек ко всей колонке целиком или к отдельным ячейкам в выходном документе.
Свойство AllowGrouping (по умолчанию true) — определяет, экспортируются ли строки групп и иерархия группировки. Если AllowGrouping имеет значение false, экспортируются только строки данных.
DocumentCulture — пользовательский объект CultureInfo, определяющий правила форматирования числовых значений и значений даты-времени в выходном документе.

Если свойство DocumentCulture не задано, механизм экспорта использует текущую культуру приложения.
Свойство ShowBands (по умолчанию null) — определяет, включаются ли группы контрола в экспорт.

Если ShowBands имеет значение null, используется значение свойства DataGridControl.ShowBands контрола.
Свойство ShowColumnHeaders (по умолчанию null) — определяет, включается ли панель заголовков колонок в экспорт.

Если ShowColumnHeaders имеет значение null, используется значение свойства DataGridControl.ShowColumnHeaders контрола.
ShowHorizontalLines — определяет, отображаются ли горизонтальные линии между ячейками в выходном документе.
ShowVerticalLines — определяет, отображаются ли вертикальные линии между ячейками в выходном документе.
Свойство TextExportMode — режим экспорта значений ячеек по умолчанию.

Доступные варианты:
- TextExportMode.Value — экспортирует значения ячеек. Если значения ячеек отформатированы в контроле DataGrid, механизм экспорта пытается применить соответствующее форматирование к экспортированным значениям в выходном документе.
- TextExportMode.Text — экспортирует отображаемый текст ячеек. Если значения ячеек отформатированы в контроле DataGrid, экспортируется отформатированное строковое представление.
Вы можете использовать свойство GridColumn.TextExportMode, чтобы переопределить настройку XlsxExportOptions.TextExportMode для отдельных колонок.
Note

Механизм экспорта учитывает только форматирование ячеек, применённое с помощью свойства GridColumn.EditorProperties. Например:
```
<mxdg:GridColumn Width="*" FieldName="Salary">
    <mxdg:GridColumn.EditorProperties>
        <mxe:TextEditorProperties DisplayFormatString="c"/>
    </mxdg:GridColumn.EditorProperties>
</mxdg:GridColumn>
```
Форматирование ячеек, применённое другими способами (например, с помощью GridColumn.CellTemplate), игнорируется при экспорте данных.

Экспорт в формат PDF¶

Механизм рендеринга PDF следует концепции WYSIWYG, сохраняя расположение элементов грида в выходном документе.

Используйте следующие методы для экспорта данных контрола в формат PDF:

DataGridControl.ExportToPdf(string fileName, PageExportOptions? options = null) — экспортирует данные в файл.
DataGridControl.ExportToPdf(Stream stream, PageExportOptions? options = null) — экспортирует данные в поток.

Необязательный параметр options (типа PageExportOptions) позволяет настроить параметры экспорта. Класс PageExportOptions предоставляет следующие члены:

Событие PageExportOptions.ExportProgress — возникает многократно в процессе экспорта данных. Параметр ExportProgressEventArgs.ProgressPercentage этого события указывает прогресс в процентах (от 0 до 100). Вы можете использовать это событие для отображения пользователям хода экспорта в удобном виде.
PageExportOptions.FitToPageWidth (по умолчанию false) — определяет, растягиваются ли колонки грида по ширине страницы.
PageExportOptions.Landscape (по умолчанию false) — определяет ориентацию страницы: горизонтальную (Landscape) или вертикальную (Portrait).
PageExportOptions.Margins (по умолчанию 72,72,72,72) — поля страницы в пунктах. 1 пункт = 1/72 дюйма.
PageExportOptions.PageRange — строка, определяющая диапазон экспортируемых страниц. Вы можете использовать следующие обозначения для указания диапазона страниц:
- "1" — экспортирует страницу 1.
- "1, 4, 8-10" — экспортирует страницы 1, 4 и с 8 по 10.
Значение по умолчанию свойства PageRange — пустая строка, при которой экспортируются все страницы.
PageExportOptions.PaperKind (по умолчанию A4) — размер бумаги.
Свойство PageExportOptions.ShowBands (по умолчанию null) — определяет, включаются ли группы контрола в экспорт.

Если ShowBands имеет значение null, используется значение свойства DataGridControl.ShowBands контрола.
Свойство PageExportOptions.ShowColumnHeaders (по умолчанию null) — определяет, включается ли панель заголовков колонок в экспорт.

Если ShowColumnHeaders имеет значение null, используется значение свойства DataGridControl.ShowColumnHeaders контрола.

Экспорт в формат CSV¶

Контрол DataGrid предоставляет метод ExportToCsv для экспорта данных в формат CSV. CSV (comma-separated values, значения, разделённые запятыми) — это текстовый формат данных для хранения табличных данных. Каждая запись экспортируется в виде текстовой строки, в которой значения разделены разделителем (как правило, запятой).

Доступны следующие перегрузки метода ExportToCsv:

DataGridControl.ExportToCsv(string filePath, TextExportMode textExportNode = TextExportMode.Text, string separator = ",", bool quoteStringsWithSeparators = true) — экспортирует данные в файл.
DataGridControl.ExportToCsv(Stream stream, TextExportMode textExportMode = TextExportMode.Text, string separator = ",", bool quoteStringsWithSeparators = true) — экспортирует данные в поток.

Следующие параметры метода позволяют настроить параметры экспорта:

textExportMode — режим экспорта значений ячеек по умолчанию.

Доступные варианты:
- TextExportMode.Value — экспортирует значения ячеек. Форматы данных, применённые к значениям ячеек, не экспортируются.
- TextExportMode.Text — экспортирует отображаемый текст ячеек. Если значения ячеек отформатированы в контроле DataGrid, экспортируется отформатированное строковое представление.
  
  Note
  
  Механизм экспорта учитывает только форматирование ячеек, применённое с помощью свойства GridColumn.EditorProperties.
Вы можете использовать свойство GridColumn.TextExportMode, чтобы переопределить параметр метода textExportMode для отдельных колонок.
separator — строка, определяющая разделитель, используемый для разделения значений ячеек в выходном документе. Разделитель по умолчанию — запятая (",").
quoteStringsWithSeparators — определяет, следует ли заключать значения в кавычки ("), если они содержат указанный separator.

Экспорт в форматы изображений¶

Метод ExportToImages контрола DataGrid выполняет постраничный экспорт в формат изображения (PNG, JPEG, SVG или WebP). Если содержимое контрола слишком велико, чтобы поместиться на одной странице, метод разбивает данные на страницы и экспортирует каждую страницу в виде отдельного изображения.

Формат и размер целевой страницы определяются параметром, передаваемым методу. Метод ExportToImages использует тот же механизм постраничной разбивки, что и метод ExportToPdf.

DataGridControl.ExportToImages(string directory, string fileNameFormat, ImageExportOptions? options = null)

using Eremex.AvaloniaUI.Controls.DataControl;
using Eremex.DocumentProcessing.Printing;

ImageExportOptions options = new ImageExportOptions();
options.Format = MxImageFormat.Svg;
options.FitToPageWidth = false;
options.PaperKind = PaperKind.A4;
options.Margins = new Margins(36, 36, 36, 36);
options.PageRange = "1-2";
dataGrid.ExportToImages(@"c:\images\", "img{0}.svg", options);

Используйте параметры метода ExportToImages для настройки параметров страницы, формата выходного изображения и шаблона имени файла.

directory — определяет каталог, в который сохраняются файлы изображений. Если указанный каталог не существует, возникает исключение.
fileNameFormat — определяет шаблон именования выходных файлов изображений.

Значение fileNameFormat должно включать плейсхолдер {0} в позиции, где нужно вставить номер страницы в сгенерированных именах файлов. Вы можете форматировать номер страницы с помощью стандартных и пользовательских числовых спецификаторов формата. Ниже приведены примеры значений fileNameFormat:
- "image{0}.png" — создаёт файлы вида "image1.png", "image2.png" и так далее.
- "image{0:D3}.svg" — создаёт файлы вида "image001.svg", "image002.svg" и так далее.

Необязательный параметр options (типа ImageExportOptions) позволяет настроить параметры экспорта. Класс ImageExportOptions предоставляет следующие члены:

ImageExportOptions.Format — выходной формат изображения (PNG, JPEG, SVG или WebP).
ImageExportOptions.PageBorderColor — цвет рамки, отображаемой вокруг каждой страницы.
ImageExportOptions.PageBorderWidth — толщина рамки, отображаемой вокруг каждой страницы.
Событие PageExportOptions.ExportProgress — возникает многократно в процессе экспорта данных. Параметр ExportProgressEventArgs.ProgressPercentage этого события указывает прогресс в процентах (от 0 до 100). Вы можете использовать это событие для отображения пользователям хода экспорта в удобном виде.
Свойство PageExportOptions.ShowBands (по умолчанию null) — определяет, включаются ли группы контрола в экспорт.

Если ShowBands имеет значение null, используется значение свойства DataGridControl.ShowBands контрола.
Свойство PageExportOptions.ShowColumnHeaders (по умолчанию null) — определяет, включается ли панель заголовков колонок в экспорт.

Если ShowColumnHeaders имеет значение null, используется значение свойства DataGridControl.ShowColumnHeaders контрола.
PageExportOptions.FitToPageWidth (по умолчанию false) — определяет, растягиваются ли колонки грида по ширине страницы.
PageExportOptions.Landscape (по умолчанию false) — определяет ориентацию страницы: горизонтальную (Landscape) или вертикальную (Portrait).
PageExportOptions.Margins (по умолчанию 72,72,72,72) — поля страницы в пунктах. 1 пункт = 1/72 дюйма.
PageExportOptions.PageRange — строка, определяющая диапазон экспортируемых страниц. Вы можете использовать следующие обозначения для указания диапазона страниц:
- "1" — экспортирует страницу 1.
- "1, 4, 8-10" — экспортирует страницы 1, 4 и с 8 по 10.
- "7-" — экспортирует страницы начиная с 7-й и до конца.
Значение по умолчанию свойства PageRange — пустая строка, при которой экспортируются все страницы.
PageExportOptions.PaperKind (по умолчанию A4) — размер бумаги.

^* Эта страница переведена с использованием технологий машинного перевода.