Платформа WT
Синтаксис
База знаний

ArrayGetDataConnection

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

Шаблон ArrayGetDataConnection

<DataConnection Name="" Type="ArrayGetDataConnection" Assembly="DataConnections">
  <Source></Source>
  <ManualRefresh></ManualRefresh>
  <Fields>
    <Field Name="" DataType="" Array=""/>
  </Fields>
</DataConnection>

Описание ArrayGetDataConnection

<DataConnection Name="ArrayGetDataConnectionName" Type="ArrayGetDataConnection" Assembly="DataConnections">
  <!--Тэги, специфичные для ArrayGetDataConnection-->
</DataConnection>

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

Source

Массив на основе которого будет строится соединения с данными.

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

<Source></Source>

ManualRefresh

Признак, определяющий условия обновления полученных данных. Если значение True, то обновление будет происходить только в ручном режиме при выполнении команды DataConnectionRefreshCommand. Если значение False, то исходные данные, помимо ручного режима, будут обновляться и автоматически при изменении источника данных, указанного в тэге <Source>.

<ManualRefresh>True</ManualRefresh>

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

По умолчанию используется значение False.

Fields

Поля запроса.

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

<Fields>
  <Field Name="Id" DataType="IntegerDataType" Array="False" />
  <Field Name="Text" />
  <Field Name="Array" DataType="IntegerDataType" Array="True" />
  <Field Name="IdCopy" DataType="IntegerDataType" Array="False" Index="0" />
</Fields>

Тэг <Field>

Поле запроса.

Порядок описания полей соответствует порядку элементов в исходном массиве. Значение поля соответствует значению элемента исходного массива.

Необязательный тэг.

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

Get-проперти для получения свойств

Count

Возвращает количество строк в указанном запроса загружающего соединения с данными.

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

<DataConnection SourceDataConnection="ArrayGetDataConnectionName">
  <Property Name="Count">SqlQueryName</Property>
</DataConnection>

ValueChanged

Возвращает признак изменения данных DataConnection.

<DataConnection SourceDataConnection="ArrayGetDataConnectionName">
  <Property Name="ValueChanged" />
</DataConnection>

RowIndexOf

Возвращает индекс строки, удовлетворяющей условиям соответствия названий столбцов и значений в этих столбцах.

<DataConnection SourceDataConnection="ArrayGetDataConnectionName">
  <Property Name="RowIndexOf">
    <Parameters>
      <Parameter Name="ColumnNames">
        <Structure Type="List">
          <Item>ColumnName1</Item>
          <Item>ColumnName2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="Values">
        <Structure Type="List">
          <Item>Value1</Item>
          <Item>Value2</Item>
        </Structure>
      </Parameter>
    </Parameters>
  </Property>
</DataConnection>

Параметр ColumnNames ожидает линейный массив названий полей DataConnection.

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

RowsIndicesOf

Возвращает массив индексов строки, удовлетворяющих условиям соответствия названий столбцов и значений в этих столбцах.

<DataConnection SourceDataConnection="ArrayGetDataConnectionName">
  <Property Name="RowsIndicesOf">
    <Parameters>
      <Parameter Name="ColumnNames">
        <Structure Type="List">
          <Item>ColumnName1</Item>
          <Item>ColumnName2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="Values">
        <Structure Type="List">
          <Item>Value1</Item>
          <Item>
            <Structure Type="List">
              <Item>Value2</Item>
              <Item>Value3</Item>
            </Structure>
          </Item>
        </Structure>
      </Parameter>
      <Parameter Name="SearchWithArrays">False</Parameter>
    </Parameters>
  </Property>
</DataConnection>

Параметр ColumnNames ожидает линейный массив названий полей DataConnection.

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

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

Column

Возвращает линейный массив значений, содержащихся в определенном столбце таблицы.

<DataConnection SourceDataConnection="ArrayGetDataConnectionName">
  <Property Name="Column">
    <Parameters>
      <Parameter Name="ColumnName">ColumnName</Parameter>
    </Parameters>
  </Property>  
</DataConnection>

Параметр ColumnName ожидает название одного из полей DataConnection.

Set-проперти для динамического задания свойств

AddRow

Добавляет новую строку в таблицу DataConnection.

<DataConnection Name="ArrayGetDataConnectionName">
  <Property Name="AddRow">
    <Parameters>
      <Parameter Name="ColumnNames">
        <Structure Type="List">
          <Item>ColumnName1</Item>
          <Item>ColumnName2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="Values">
        <Structure Type="List">
          <Item>Value1</Item>
          <Item>Value2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="Index">0</Parameter>
      <Parameter Name="FireChanged">False</Parameter>
    </Parameters>
  </Property>
</DataConnection>

Параметр ColumnNames ожидает линейный массив названий полей DataConnection.

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

Необязательный параметр Index ожидает неотрицательное целочисленное значение, указывающее место вставки новой строки. Если параметр отсутствует, то строка добавляется в конец таблицы DataConnection.

Необязательный параметр FireChanged - признак того, что соединение с данными будет рассылать событие об изменении данных при выполнении set-проперти. Ожидается логическое значение. По умолчанию используется значение True.

AddRows

Добавляет новые строки в таблицу DataConnection.

<DataConnection Name="ArrayGetDataConnectionName">
  <Property Name="AddRows">
    <Parameters>
      <Parameter Name="ColumnNames">
        <Structure Type="List">
          <Item>ColumnName1</Item>
          <Item>ColumnName2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="Values">
        <DataConnection SourceDataConnection="SourceDataConnectionName">
          <Fields>
            <Field Name="ColumnName1" />
            <Field Name="ColumnName2" />
          </Fields>
        </DataConnection>
      </Parameter>
      <Parameter Name="Index">0</Parameter>
      <Parameter Name="RawValues">True</Parameter>
      <Parameter Name="FireChanged">False</Parameter>
    </Parameters>
  </Property>
</DataConnection>

Параметр ColumnNames ожидает линейный массив названий полей DataConnection.

Параметр Values ожидает таблицу (например, ссылка на GetDataConnection) с числом столбцов равным числу имен столбцов, указанных в параметре ColumnNames. Допустимо указывать линейный массив, который будет соответствовать одной строке.

Необязательный параметр Index ожидает неотрицательное целочисленное значение, указывающее место вставки новой строки. Если параметр отсутствует, то строка добавляется в конец таблицы DataConnection.

Необязательный параметр RawValues - признак того, что значения необходимо подставлять "как они есть" - без преобразования в массив скалярных значений. Ожидается логическое значение. По умолчанию используется значение False.

Необязательный параметр FireChanged - признак того, что соединение с данными будет рассылать событие об изменении данных при выполнении set-проперти. Ожидается логическое значение. По умолчанию используется значение True.

UpdateRow

Изменяет значения полей в строке с указанным индексом.

<DataConnection Name="ArrayGetDataConnectionName">
  <Property Name="UpdateRow">
    <Parameters>
      <Parameter Name="RowIndex">0</Parameter>
      <Parameter Name="ColumnNames">
        <Structure Type="List">
          <Item>ColumnName1</Item>
          <Item>ColumnName2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="Values">
        <Structure Type="List">
          <Item>Value1</Item>
          <Item>Value2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="RawValues">True</Parameter>
      <Parameter Name="FireChanged">False</Parameter>
    </Parameters>
  </Property>
</DataConnection>

Параметр ColumnNames ожидает линейный массив названий полей DataConnection.

Параметр Values ожидает линейный массив любых значений.

Параметр RowIndex ожидает неотрицательное целочисленное значение, указывающее на индекс строки для изменения.

Необязательный параметр RawValues - признак того, что значения необходимо подставлять "как они есть" - без преобразования в массив скалярных значений. Ожидается логическое значение. По умолчанию используется значение False.

Необязательный параметр FireChanged - признак того, что соединение с данными будет рассылать событие об изменении данных при выполнении set-проперти. Ожидается логическое значение. По умолчанию используется значение True.

UpdateRows

Изменяет значения полей в строках с указанными индексами на соответствующее значение из массива.

<DataConnection Name="ArrayGetDataConnectionName">
  <Property Name="UpdateRows">
    <Parameters>
      <Parameter Name="RowIndices">
        <Structure Type="List">
          <Item>1</Item>
          <Item>2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="ColumnNames">
        <Structure Type="List">
          <Item>ColumnName1</Item>
          <Item>ColumnName2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="Values">
        <Structure Type="List">
          <Item>Value1</Item>
          <Item>Value2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="ReplicateValues">False</Parameter>
      <Parameter Name="RawValues">True</Parameter>
      <Parameter Name="FireChanged">False</Parameter>
    </Parameters>
  </Property>
</DataConnection>

Параметр ColumnNames ожидает линейный массив названий полей DataConnection.

Параметр Values ожидает линейный массив или матрицу любых значений.

Параметр RowIndices ожидает линейный массив неотрицательных целочисленных значений, указывающих на индексы строк для изменения.

Необязательный параметр ReplicateValues - признак, определяющий каким образом обрабатывать значение параметра Values. Ожидает логическое значение. По умолчанию используется значение True.

Если значение параметра False, то значение параметра Values рассматривается как матрица значений, которые будут записаны в строки с индексами, указанными в параметре RowIndices. При этом:

  • если количество элементов строки матрицы не совпадает с количеством полей, указанных в параметре ColumnNames, то в соответствующие ячейки ставится значение NULL;

  • если количество строк матрицы не совпадает с количеством индексов, указанных в параметре RowIndices, то в ячейки строки, у которых отсутствует строка в матрице, ставится значение NULL.

Если значение параметра True, то значение параметра Values рассматривается как линейный массив значений, который заполняет каждую строку, подставляя элементы в соответствующие колонки.

Необязательный параметр RawValues - признак того, что значения необходимо подставлять "как они есть" - без преобразования в массив скалярных значений. Ожидается логическое значение. По умолчанию используется значение False.

Необязательный параметр FireChanged - признак того, что соединение с данными будет рассылать событие об изменении данных при выполнении set-проперти. Ожидается логическое значение. По умолчанию используется значение True.

UpdateColumn

Построчно изменяет значения строк в заданном поле на соответствующие значения из массива.

<DataConnection Name="ArrayGetDataConnectionName">
  <Property Name="UpdateColumn">
    <Parameters>
      <Parameter Name="ColumnName">ColumnName</Parameter>
      <Parameter Name="Values">
        <Structure Type="List">
          <Item>Value1</Item>
          <Item>Value2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="RawValues">True</Parameter>
      <Parameter Name="FireChanged">False</Parameter>
    </Parameters>
  </Property>
</DataConnection>

Параметр ColumnName ожидает название поля DataConnection.

Параметр Values ожидает линейный массив любых значений. Если длина массива меньше количества строк в соединении с данными, то оставшиеся строки не будут изменяться. Если длина массива больше, то оставшиеся значения будут отброшены.

Необязательный параметр RawValues - признак того, что значения необходимо подставлять "как они есть" - без преобразования в массив скалярных значений. Ожидается логическое значение. По умолчанию используется значение False.

Необязательный параметр FireChanged - признак того, что соединение с данными будет рассылать событие об изменении данных при выполнении set-проперти. Ожидается логическое значение. По умолчанию используется значение True.

UpdateColumnCellsValues

Изменяет значение поля в строках с указанными индексами на заданное значение.

<DataConnection Name="ArrayGetDataConnectionName">
  <Property Name="UpdateColumnCellsValues">
    <Parameters>
      <Parameter Name="ColumnName">ColumnName</Parameter>
      <Parameter Name="RowIndices">
        <Structure Type="List">
          <Item>1</Item>
          <Item>2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="Value">Value</Parameter>
      <Parameter Name="RawValues">True</Parameter>
      <Parameter Name="FireChanged">False</Parameter>
    </Parameters>
  </Property>
</DataConnection>

Параметр ColumnName ожидает название поля DataConnection.

Параметр Value ожидает значение, которое будет подставляться в поле.

Необязательный параметр RowIndices ожидает линейный массив неотрицательных целочисленных значений, указывающих на индексы строк. Если параметр не указан, то обновятся все строки.

Необязательный параметр FireChanged - признак того, что соединение с данными будет рассылать событие об изменении данных при выполнении set-проперти. Ожидается логическое значение. По умолчанию используется значение True.

DeleteRowsByIndices

Удаляет строки с указанными индексами.

<DataConnection Name="ArrayGetDataConnectionName">
  <Property Name="DeleteRowsByIndices">
    <Parameters>
      <Parameter Name="Value">
        <Structure Type="List">
          <Item>1</Item>
          <Item>2</Item>
        </Structure>
      </Parameter>
      <Parameter Name="FireChanged">False</Parameter>
    </Parameters>
  </Property>
</DataConnection>

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

Необязательный параметр FireChanged - признак того, что соединение с данными будет рассылать событие об изменении данных при выполнении set-проперти, а так же будет изменяться свойство ValueChanged. Ожидается логическое значение. По умолчанию используется значение True.

FireChanged

Рассылает событие об изменении данных.

Значение не ожидается.

<DataConnection Name="ArrayGetDataConnectionName">
  <Property Name="FireChanged" />
</DataConnection>

ValueChanged

Задает признак изменения значения соединения с данными.

Ожидается логическое значение.

<DataConnection Name="ArrayGetDataConnectionName">
  <Property Name="ValueChanged">False</Property>
</DataConnection>

Last updated