ExportTableToCsvCommand

Команда; экспортирует данные из таблицы в файл формата CSV.

Шаблон ExportTableToCsvCommand

<Command Name="" Type="ExportTableToCsvCommand" Assembly="Commands">
  <!--Тэги, общие для всех команд-->
  <Condition Name="" />
  <Lock Value="" />
  <!--Тэги, специфичные для ExportTableToCsvCommand-->
  <Async Value="" />
  <Table Name="TableName" />
  <ExcludeColumnHeaders Value="" />
  <Columns>
    <Column Name=""></Column>
    <Column Name=""></Column>
  </Columns>
  <FilterRows ColumnName=""></FilterRows>
  <ExportPath Ask=""></ExportPath>
  <Open></Open>
</Command>

Описание ExportTableToCsvCommand

<Command Name="ExportTableToCsvCommandName" Type="ExportTableToCsvCommand" Assembly="Commands">
  <!--Тэги, общие для всех команд-->
  <!--Тэги, специфичные для ExportTableToCsvCommand-->
</Command>

Результат выполнения ExportTableToCsvCommand

Value

Полный путь с названием файла, в который было выгружено содержимое.

Тэги, специфичные для ExportTableToCsvCommand

Async

Признак, определяющий, будет ли выполнение команды происходить в асинхронном режиме (в фоновом потоке).

Необязательный тэг. Значение тэга <Async>: не ожидается.

Если тэг <Async> отсутствует, то для атрибута Value используется значение False.

<Async Value="False" />

Атрибуты тэга <Async>

Value

Значение. Обязательный атрибут. Ожидается логическое значение.

Table

Таблица, данные которой будут выгружаться в файл.

Обязательный тэг. Значение тэга <Table>: не ожидается.

<Table Name="TableName" />

Атрибуты тэга <Table>

Name	Название одной из таблиц, описанных в форме. Обязательный атрибут. Ожидается название одной из таблиц, описанных в форме.

ExcludeColumnHeaders

Признак, определяющий, экспортировать ли заголовки столбцов.

Необязательный тэг. Значение тэга <ExcludeColumnHeaders>: не ожидается.

Если тэг <ExcludeColumnHeaders> отсутствует, то для атрибута Value используется значение False.

<ExcludeColumnHeaders Value="False" />

Атрибуты тэга <ExcludeColumnHeaders>

Value

Значение. Обязательный атрибут. Ожидается логическое значение.

Columns

Экспортируемые столбцы.

Необязательный тэг. Значение тэга <Columns>: список тэгов <Column>.

Если тэг <Columns> отсутствует, то экспортируются все видимые столбцы таблицы.

<Columns>
  <Column Name="ColumnName1">True</Column>
  <Column Name="ColumnName2">False</Column>
  <Column Name="ColumnName3" />
</Columns>

Тэг <Column>

Экспортируемый столбец с признаком, задаваемым в значении тэга <Column>, следует ли его экспортировать.

Необязательный тэг. Ожидается логическое значение.

Если значение тэга <Column> равно NULL, то столбец считается экспортируемым.

Атрибуты тэга <Column>

Name	Имя столбца. Обязательный атрибут. Значение атрибута Name: имя одного из столбцов указанной таблицы.

FilterRows

Фильтрация экспортируемых строк по соответствию значений определенного столбца набору определенных значений.

Необязательный тэг. Ожидается любое скалярное значение или линейный массив.

Если тэг <FilterRows> отсутствует, то экспортируются все видимые строки таблицы.

<FilterRows ColumnName=""></FilterRows>

Атрибуты тэга <FilterRows>

ColumnName

Имя столбца, значения которого будут сравниваться с набором значений из тэга <FilterRows>. Обязательный атрибут. Значение атрибута ColumnName: имя одного из столбцов указанной таблицы.

ExportPath

Путь до папки, в которой будет расположен файл с выгруженными данными.

Необязательный тэг. Любое значение будет переведено в текстовое.

Если тэг <ExportPath> отсутствует, то используется пустое значение, а для атрибута Ask используется значение False.

Поддерживаются константы замены.

<ExportPath Ask="False">ExportPath</ExportPath>

Атрибуты тэга <ExportPath>

Ask	Признак, определяющий, будет ли вызвано диалоговое окно для выбора файла для экспорта. Необязательный атрибут. Ожидается логическое значение. Если атрибут Ask отсутствует, то используется значение False.

Open

Признак открытия CSV-файла после формирования.

Необязательный тэг. Ожидается логическое значение.

Если тэг <Open> отсутствует, то используется значение False.

<Open>False</Open>