TbtkScriptControllerObject
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

.. pas:class:: TbtkScriptControllerObject

  Класс реализующий интерфейс взаимодействия с выборой посредством GUI контрола.

  .. pas:method:: ShowEditor()

    Метод позволяет отобразить редактор в списке или дереве в текущей
    ячейке.

    .. warning:: |not_implemented|

  .. pas:method:: Repaint()

    Функция выполняет перерисовку GUI за который отвечает контроллер.
    Например, при изменении свойства **Mandatory** у атрибута, необходимо
    выполнить ``Repaint``, чтобы изменения отобразились на экране.

    .. warning:: |not_supported|

  .. pas:attribute:: Text: TbtkScriptTextViewObject

    Свойство возвращает объект, инкапсулирующий API для работы с выделением
    текста и управления курсором в редакторах.

    Поддержка данных API реализована в следующих редакторах:
    - Script editor
    - HTML editor
    - Text View

    :rtype: TbtkScriptTextViewObject

    .. versionadded:: BtkRuntime 5.4.0.3582 ms 1

    .. code-block:: delphi
      :caption: Пример использования

      <pascal>
      if Assigned(Selection.Controller.Text) then
        Selection.Controller.Text.TopLine := 50;
      </pascal>

    .. warning:: |not_supported|

  .. pas:method:: SetFocus()

    Перевод фокуса ввода на оконный элемент выборки.

    .. warning:: |not_supported|

  .. pas:attribute:: ClientFilter: TbtkScriptClientFilterObject

    Ссылка на объект :pas:class:`TbtkScriptClientFilterObject`,
    через который осуществляется управление клиентским фильтром

    :rtype: TbtkScriptClientFilterObject

    .. warning:: |not_supported|


Drag & Drop
.............

.. pas:class::

  .. pas:attribute:: DragObject: Interface

    Свойство возвращает источник, который инициировал перетаскивание, тип
    источника :pas:class:`TbtkScriptSelectionObject`. Перед использованием
    ``Controller.DragObject`` следует проверить его с использованием функции
    ``Assigned``. Использовать данное свойство можно из операций-триггеров
    ``onDragOver`` и ``onDragDrop``. `onDragOver` вызывается при перемещении указателя
    в в состоянии «перетаскивание». ``onDragDrop`` – вызывается в момент
    «бросания» перетаскиваемого объекта.

    :rtype: Interface

    .. seealso::
      :ref:`frames_dragdrop`

    .. code-block:: delphi
      :caption: Пример использования

      // Для возможности перетаскивания объектов между списками и деревьями. В
      // каждую выборку участвующие в перетаскивание записей следует добавить
      // операции: onCanStartDrag, onDragOver, OnDragDrop.

      // Пример операции onCanStartDrag:
      <pascal>
        Selection.Controller.BeginDrag(false, 8);
      </pascal>

      // onDragOver:
      <pascal>
        SelObj := Selection.Controller.DragObject;
        if Assigned(SelObj) and (SelObj.representation <> Selection.Representation) then
          Selection.Controller.AcceptDragObject := true
        else
          Selection.Controller.AcceptDragObject := false;
      </pascal>

      // onDragDrop:
      <pascal>
        sel := selection.Controller.DragObject;
        ShowMessage(Sel.EntityName + '.' + Sel.Representation);
      </pascal>

  .. pas:attribute:: DragRecord: TbtkScriptRecordObject

    Ссылка на обёртку записи списка или дерева, либо элемента диаграммы,
    над которой находится курсор мыши.
    Свойство следует использовать в операциях–триггерах **onDragDrop** и **onDragOver**.

    .. note::

      Для диаграммы возвращается обёртка на запись выборки **SEL_BTD_OBJECT.OBJECTSOFDIAGRAM**.
      При этом доступно только поле с именем **id**.

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

    .. seealso::
      :ref:`frames_dragdrop`

    :rtype: TbtkScriptRecordObject


  .. pas:attribute:: AcceptDragObject: Boolean

    Свойство определяет возможноть «принятия» перетаскиваемого объекта
    объектом, над которым находится указатель мыши. Использовать данное
    свойство следует использовать в операции – триггере ``onDragOver``, которая
    вызывается автоматически при перемещении указателя в режиме
    «перетаскивание».

    :rtype: Boolean

    .. seealso::
      :ref:`frames_dragdrop`

    .. code-block:: delphi
      :caption: Пример использования

      // Для возможности перетаскивания объектов между списками и деревьями. В
      // каждую выборку участвующие в перетаскивание записей следует добавить
      // операции: onCanStartDrag, onDragOver, OnDragDrop.

      // Пример операции onCanStartDrag:
      <pascal>
        Selection.Controller.BeginDrag(false, 8);
      </pascal>

      // onDragOver:
      <pascal>
        SelObj := Selection.Controller.DragObject;
        if Assigned(SelObj) and (SelObj.representation <> Selection.Representation) then
          Selection.Controller.AcceptDragObject := true
        else
          Selection.Controller.AcceptDragObject := false;
      </pascal>

      // onDragDrop:
      <pascal>
        sel := selection.Controller.DragObject;
        ShowMessage(Sel.EntityName + '.' + Sel.Representation);
      </pascal>


  .. pas:method:: SetDropAsChild(Value: Boolean)

    Метод можно использовать в операции ``OnDragDrop``, в случае если
    используется режим автоматического переноса
    записей (``DragAndDropRows.AutoDropTo``) то с помощью этого метода можно
    определить как перенести запись, как потомка относительно записи на
    которую перетаскиваем, или на тот же уровень. Метод действует только на
    один перенос, после чего значение **DropAsChild** сбрасывается (вызов надо
    делать перед каждым бросанием). По умолчанию запись перемещается в
    список потомков.

    :param Boolean Value:
      Новое значение для параметра **DropAsChild**.

    .. seealso::
      :ref:`frames_dragdrop`

    .. warning:: |not_implemented|


  .. pas:method:: BeginDrag(Immediate: Boolean; Threshold: Integer)

    Процедура запускает перетаскивание объекта на котором удерживается
    нажатый указатель мыши. Перетаскивать можно записи со списков и деревьев
    на списки и деревья. Данную процедуру следует использовать из операции
    триггера ``onCanDragObject``, если свойство фрейма
    ``DragAndDropRows.DragMode`` равно **dmManual** Операция ``onCanStartDrag``
    вызывается автоматически, если режим перетаскивания установлен как
    ручной.

    :param Boolean Immediate:
      Если данный параметр установлен в **True**, то режим перетаскивания будет
      включен не замедлительно, сразу по нажатию на кнопку мыши, иначе режим
      перетаскивания включится только после смещение указателя на кол-во
      пикселей указанное в параметре *Threshold*.

    :param Integer Threshold:
      Количество пикселей, на которое необходимо сдвинуть, чтобы началось
      перетаскивание объекта.

    .. seealso::
      :ref:`frames_dragdrop`

    .. warning:: |not_implemented|

Выделение (Deprecated)
......................................................................

.. pas:class::

  .. pas:attribute:: SelectedText: String

    Позволяет получить выделенный текст и заменить в текущем сфокусированном
    однострочном либо многострочном графическом редакторе. Если выделение
    отсутствует тогда при присвоении свойства происходит вставка в место
    установки курсора.

    :rtype: String

    .. deprecated:: Устарело

    .. warning:: |not_implemented|


  .. pas:attribute:: SelectionLength: Integer

    Длина выделенного текста в символах в текущем сфокусированном
    однострочном либо многострочном графическом элементе ввода кроме HTML
    редактора.

    :rtype: Integer

    .. deprecated:: Устарело

    .. warning:: |not_implemented|


  .. pas:attribute:: SelectionStart: Integer

    Порядковый номер первого символа выделенного текста в текущем
    сфокусированном однострочном либо многострочном графическом элементе
    ввода кроме HTML редактора. Нумерация идет с 1.

    :rtype: Integer

    .. deprecated:: Устарело

    .. warning:: |not_implemented|


Итоги
......................................................................

.. pas:class::

  .. pas:method:: FieldAddSummaryT(SummaryType: TSummaryType; FieldName: String)

    Метод добавляет итоги для колонки транспонированного списка.

    :param TSummaryType SummaryType:
      Тип итогов.

    :param String FieldName:
      Имя атрибута выборки.

    .. warning:: |not_implemented|


  .. pas:method:: FieldExAddGroupSummaryT(SummaryType: TSummaryType; FieldName: String)

    Метод добавляет итоги для колонок транспонированного списка из области
    группировки.

    :param TSummaryType SummaryType:
      Тип итогов.

    :param String FieldName:
      Имя атрибута выборки.

    .. warning:: |not_implemented|


  .. pas:method:: ClearSummary()

    Скрывает итоги у всех столбцов


  .. pas:method:: ClearGroupSummary()

    Скрывает итоги у всех столбцов группировки

    .. warning:: |not_implemented|


  .. pas:method:: FieldAddSummary(SummaryType: TSummaryType; FieldName: String)

    Метод добавляет итоги для колонки.

    :param TSummaryType SummaryType:
      Тип итогов.

    :param String FieldName:
      Имя атрибута выборки.


  .. pas:method:: FieldAddGroupSummary(SummaryType: TSummaryType; FieldName: String)

    Метод добавляет итоги для колонок из области группировки.

    :param TSummaryType SummaryType:
      AFieldName

    :param String FieldName:
      Имя атрибута выборки.

    .. warning:: |not_implemented|


  .. pas:method:: GetSummary(AttrName: String; SummaryType: TSummaryType): Integer

    Метод возвращает итоги для колонки списка с именем *AttrName*.
    Метод работает только с полностью прогруженным списком. Для частично
    прогруженного списка следует воспльзоваться свойством
    ``Selection.Partitioned``.

    :param String AttrName:
      Имя атрибута.

    :param TSummaryType SummaryType:
      Тип итогов.

    :rtype: Integer

    .. warning:: |not_implemented|


  .. pas:attribute:: FooterVisible: Boolean

    Управляет видимостью области итогов

    :rtype: Boolean

    .. code-block:: delphi
      :caption: Пример использования

      <pascal>
        c := selection.controller;
        if c.GroupFootersVisible = true then
          c.GroupFootersVisible := false
        else
        begin
          c.GroupFootersVisible := true;
          c := selection.controller;
          c.FieldAddSummary(ctSummarySum,'nRegnumber');
          c.FieldAddSummary(ctSummaryCount,'nRegdata');
          c.FieldAddGroupSummary(ctSummaryCount,'nRegnumber');
          c.FieldAddGroupSummary(ctSummarySum,'nRegdata');
        end;
      </pascal>

  .. pas:attribute:: GroupFootersVisible: Integer

    Управляет видимостью области итогов для группирвки.

    :rtype: Integer

    .. code-block:: delphi
      :caption: Пример использования

      <pascal>
        c := selection.controller;
        if c.GroupFootersVisible = true then
          c.GroupFootersVisible := false
        else
        begin
          c.GroupFootersVisible := true;
          c := selection.controller;
          c.FieldAddSummary(ctSummarySum,'nRegnumber');
          c.FieldAddSummary(ctSummaryCount,'nRegdata');
          c.FieldAddGroupSummary(ctSummaryCount,'nRegnumber');
          c.FieldAddGroupSummary(ctSummarySum,'nRegdata');
        end;
      </pascal>

    .. deprecated:: Устарел

    .. warning:: |not_implemented|


  .. pas:attribute:: GroupSummaryVisible: Boolean

    Управляет видимостью промежуточных итогов.

    :rtype: boolean

    .. warning:: |not_supported|


  .. pas:attribute:: GroupFootersMode: TbtkGroupFootersMode

    Управляет отображением :term:`футера <Футер>` группировки.

    :rtype: TbtkGroupFootersMode

    .. seealso:: Свойство фрейма :btk:frameprop:`GroupFootersMode`

    .. warning:: |not_supported|


  .. pas:attribute:: GroupSummaryPosition: TbtkGroupSummaryPosition 

    Управляет положением промежуточных итогов.

    :rtype: TbtkGroupSummaryPosition

    .. seealso:: Свойство фрейма :btk:frameprop:`GroupSummaryPosition`

    .. warning:: |not_supported|


Группировка
......................................................................

.. pas:class::

  .. pas:method:: GroupsFullCollaps()

    Метод схлопывает все узлы группировок, а также выключает свойство :btk:frameprop:`GroupsFullExpand`.

    .. seealso::

      * Свойство фрейма :btk:frameprop:`GroupsFullExpand`

      * :pas:meth:`CollapseGroups`

  .. pas:method:: CollapseGroups()

    Метод схлопывает все узлы группировок.

    .. seealso::

      :pas:meth:`GroupsFullCollaps`

    .. warning:: |not_supported|


  .. pas:method:: GroupsAddField(FieldName: String)

    Метод добавляет атрибут с именем *FieldName* в область группировки.
    (Атрибут становится не видимым в списке)

    :param String FieldName:
      имя атрибута выборки


  .. pas:method:: GroupsRemoveField(FieldName: String)

    Метод удаляет атрибут с именем *FieldName* из область группировки.
    (Атрибут становится видимым в списке)

    :param String FieldName:
      имя атрибута выборки


  .. pas:method:: GroupsCount(): Integer

    Метод возвращает количество атрибутов в области группировки

    :rtype: Integer


  .. pas:method:: GroupsGetIndex(FieldName: String): Integer

    Метод возвращает порядковый номер атрибута в области группировки. Если
    атрибут не в обрасти группировки, метод вернёт **-1**

    :param String FieldName:
      имя атрибута выборки

    :rtype: Integer


  .. pas:method:: GroupsFullExpand()

    Метод раскрывает все узлы группировок, а также включает свойство :btk:frameprop:`GroupsFullExpand`.

    .. seealso::

      * Свойство фрейма :btk:frameprop:`GroupsFullExpand`

      * :pas:meth:`ExpandGroups`

  .. pas:method:: ExpandGroups()

    Метод разворачивает все узлы группировок.

    .. seealso::

      :pas:meth:`GroupsFullExpand`

    .. warning:: |not_supported|


  .. pas:method:: GroupsClear()

    Метод удаляет все атрибуты из области группировки.


  .. pas:attribute:: GroupsVisible: Boolean

    Свойство управляет видимостью области группировки.

    :rtype: Boolean

    .. code-block:: delphi
      :caption: Пример использования

      <pascal>
        If Assigned(Selection.Controller) then
        begin
          Selection.Controller.GroupsVisible := True;
          Selection.Controller.GroupsAddField('sCaption');
          Selection.Controller.GroupsAddField('sSystemName');
          Selection.Controller.GroupsFullExpand;
        end;

        c := selection.controller;
        c.FieldAddSummary(ctSummarySum,'nRegnumber');
        c.FieldAddSummary(ctSummaryCount,'nRegdata');
        c.FieldAddGroupSummary(ctSummaryCount,'nRegnumber');
        c.FieldAddGroupSummary(ctSummarySum,'nRegdata');
      </pascal>

Списочный вид
......................................................................

.. pas:class::

  .. pas:method:: SetDecimalNumbers(FieldName: String; DigCount: Integer)

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

    :param String FieldName:
      Имя атрибута выборки.

    :param Integer DigCount:
      Количество знаков после запятой.

    .. warning:: |not_implemented|


  .. pas:method:: SetDecimalNumbersToAll(DigCount: Integer)

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

    :param Integer DigCount:
      Количество знаков после запятой.

    .. warning:: |not_implemented|


  .. pas:method:: FixColumn(FieldName: String; Position: Boolean)

    Метод, позволяющий зафиксировать колонку в гриде из скрипта

    :param String FieldName:
      имя атрибута

    :param Boolean Position:
      позиция фиксации

      True
        влево

      False
        вправо

    .. warning:: |not_implemented|


  .. pas:attribute:: ColumnAutoSize: Boolean

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

    :rtype: Boolean

    .. warning:: |not_implemented|


  .. pas:method:: ApplyBestColumnSize()

    Функциональность метода идентична пункту выпадающего меню "Подобрать
    ширину колонкам". Метод распространяется на дерево, Grid и
    TransposeGrid.


  .. pas:attribute:: Hints: TbtkScriptHintController

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

    :rtype: TbtkScriptHintController

    .. warning:: |not_implemented|


Команды
......................................................................

.. pas:class::

  .. pas:method:: QueryCommandEnabled(CmdId: String): Boolean

    Метод проверяет доступна ли GUI-команда в данный момент.

    .. seealso::

      -  :pas:class:`TbtkScriptControllerObject.ExecCommand`
      -  :pas:class:`TbtkScriptControllerObject.QueryCommandSupported`
      -  :pas:class:`TbtkScriptControllerObject.QueryCommandValue`

    :param String CmdId:
      Наименование команды. Например: 'Copy', 'Paste', 'SelectAll' и т.д.

    :rtype: Boolean

    .. deprecated:: Устарел

    .. warning:: |not_supported|


  .. pas:method:: ExecCommand(CmdId: String; ShowInUI: Boolean; Value: Variant=null): Boolean

    Выполняет команду доступную пользователю через GUI контроллера данной выборки.

    Команды - это ядровой функционал GUI-контроллера выборки, как правило,
    операции вынесенные на встроенные во врейм панели управления.

    .. seealso::

      -  :pas:class:`TbtkScriptControllerObject.QueryCommandSupported`
      -  :pas:class:`TbtkScriptControllerObject.QueryCommandValue`
      -  :pas:class:`TbtkScriptControllerObject.QueryCommandEnabled`

    :param String CmdId:
      Наименование команды. Например: 'Copy', 'Paste', 'SelectAll' и т.д.

    :param Boolean ShowInUI:
      Будет ли использоваться во время выполнения команды взаимодействие с
      пользователем.
      Параметр может использоваться некоторыми командами.

    :param Variant Value:
      Значение принимаемое некоторыми командами, как правло они
      ассоциированными со значением, а не действием.

      Например: ``ExecCommand('FontName', False, 'Times New Roman')``

    :rtype: Boolean

    .. deprecated:: Устарел

    .. warning:: |not_supported|


  .. pas:method:: QueryCommandSupported(CmdId: String): Boolean

    Метод проверяет существует ли указанная GUI-команда в данном интерфейсе.

    .. seealso::

      -  :pas:class:`TbtkScriptControllerObject.ExecCommand`
      -  :pas:class:`TbtkScriptControllerObject.QueryCommandEnabled`
      -  :pas:class:`TbtkScriptControllerObject.QueryCommandValue`

    :param String CmdId:
      Наименование команды. Например: 'Copy', 'Paste', 'SelectAll' и т.д.

    :rtype: Boolean

    .. deprecated:: Устарел

    .. warning:: |not_supported|


  .. pas:method:: QueryCommandValue(CmdId: String): Variant

    Метод возвращает значение ассоциированное с командой, если команда
    поддерживает значение. В противном случае, если не поддерживает
    (команда только выполняемая), - возвращается значение **False**.

    Например: ``QueryCommandValue('FontName')``

    .. seealso::

      -  :pas:class:`TbtkScriptControllerObject.ExecCommand`
      -  :pas:class:`TbtkScriptControllerObject.QueryCommandEnabled`
      -  :pas:class:`TbtkScriptControllerObject.QueryCommandSupported`

    :param String CmdId:
      Наименование команды. Например: 'Copy', 'Paste', 'SelectAll' и т.д.

    :rtype: Variant

    .. deprecated:: Устарел

    .. warning:: |not_supported|


Навигация по контролу
......................

.. pas:class::

  .. pas:method:: VisibleElementCount(): Integer

    Количество видимых элементов (для списочных фреймов - строк) контрола на экране
    с учетом сортировок и фильтрации.

    :rtype: Integer

    .. warning:: |not_supported|


  .. pas:method:: IsEmpty(): Boolean

    Проверяет отсутствие в контроле элементов (для списочных фреймов -
    строк) для вывода на экран.

    :rtype: Boolean

    .. note::

      Метод вернет **True**, если все записи будут
      отфильтрованы клиентским автофильтром.

    .. warning:: |not_supported|


  .. pas:method:: IsLast(): Boolean

    Проверяет является ли текущий элемент (для списочных фреймов - строка)
    последним в порядке вывода на экран с учетом сортировок и фильтрации.

    :rtype: Boolean

    .. seealso::
      - :pas:class:`TbtkScriptSelectionObject.ReportFirst`
      - :pas:class:`TbtkScriptSelectionObject.ReportNext`
      - :pas:class:`TbtkScriptSelectionObject.ReportEOF`

    .. warning:: |not_supported|

  .. pas:method:: Last()

    Перейти к последнему элементу.
    Для списочных контролов к последней строке в порядке вывода на экран с учетом сортировок и фильтрации.

    .. warning:: |not_supported|


  .. pas:method:: First()

    Перейти к первому элементу.
    Для списочных контролов к первой строке в порядке вывода на экран с учетом сортировок и фильтрации.

    .. seealso::
      - :pas:class:`TbtkScriptSelectionObject.ReportFirst`
      - :pas:class:`TbtkScriptSelectionObject.ReportNext`
      - :pas:class:`TbtkScriptSelectionObject.ReportEOF`

    .. warning:: |not_supported|


  .. pas:method:: Prior()

    Перейти к предыдущему элементу.
    Для списочных контролов к предыдущей строке в порядке вывода на экран с учетом сортировок и фильтрации.

    .. warning:: |not_supported|


  .. pas:method:: Next()

  Перейти к следующему элементу. Для списочных контролов к следующей строке в порядке вывода на экран с учетом сортировок и фильтрации.

  .. seealso::
    - :pas:class:`TbtkScriptSelectionObject.ReportFirst`
    - :pas:class:`TbtkScriptSelectionObject.ReportNext`
    - :pas:class:`TbtkScriptSelectionObject.ReportEOF`


  .. warning:: |not_supported|

.. _TbtkScriptControllerObject_Selection:

Выделение записей
..................

.. seealso::
  :ref:`Выделение в TbtkScriptSelectionObject<TbtkScriptSelectionObject_Selection>`

.. pas:class::

  .. pas:method:: GetSelectedRecords: Variant

    Возвращает выделенные записи.

    .. tip::

      В паре с :pas:meth:`SetSelectedRecords` может использоваться
      для сохранения выделения в операциях приводящих к его сбрасыванию.
    
    :rtype: Variant

    :returns:
      Массив идентификаторов выделенных записей.

    .. warning:: |not_supported|

  .. pas:method:: SetSelectedRecords(RecordsToSelect: Variant);

    Выделяет указанные записи.
    
    .. tip::

      В паре с :pas:meth:`GetSelectedRecords` может использоваться
      для сохранения выделения в операциях приводящих к его сбрасыванию.

    :param Variant RecordsToSelect:
      Массив идентификаторов записей для выделения.

    .. warning:: |not_supported|

Перемещение записей
....................

.. pas:class::

  .. pas:method:: MoveRecordsUp(RecordsToMove: Variant)

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

    .. attention::

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

    :param Variant RecordsToMove:
      Идентификаторы перемещаемых записей. Может принимать как одно значение, так и массив.
      Каждому передаваемому значению обязательно должна соответствовать запись.

    .. warning:: |not_supported|


  .. pas:method:: MoveRecordsDown(RecordsToMove: Variant)

    Перемещает указанные записи вниз.

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

    :param Variant RecordsToMove:
      Идентификаторы перемещаемых записей. Может принимать как одно значение, так и массив.
      Каждому передаваемому значению обязательно должна соответствовать запись.

    .. attention::

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

    .. warning:: |not_supported|


  .. pas:method:: MoveRecordsLeft(RecordsToMove: Variant)

    Перемещает указанные записи влево.

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

    :param Variant RecordsToMove:
      Идентификаторы перемещаемых записей. Может принимать как одно значение, так и массив.
      Каждому передаваемому значению обязательно должна соответствовать запись.

    .. attention::

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

    .. warning:: |not_supported|


  .. pas:method:: MoveRecordsRight(RecordsToMove: Variant)

    Перемещает указанные записи вправо.

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

    :param Variant RecordsToMove:
      Идентификаторы перемещаемых записей. Может принимать как одно значение, так и массив.
      Каждому передаваемому значению обязательно должна соответствовать запись.

    .. attention::

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

    .. warning:: |not_supported|

TSummaryType
..............

.. pas:class:: TSummaryType

  Перечисление. Способы вычисления итогов полей данных.

  .. pas:attribute:: ctNoSummary

    Без итогов.


  .. pas:attribute:: ctSummaryCount

    Количество значений.


  .. pas:attribute:: ctSummarySum

    Сумма всех числовых значений.


  .. pas:attribute:: ctSummaryMax

    Наибольшее значение.


  .. pas:attribute:: ctSummaryMin

    Наименьшее значение.


  .. pas:attribute:: ctSummaryAvg

    Среднее арифметическое для всех числовых значений.


TbtkGroupFootersMode
....................

.. pas:class:: TbtkGroupFootersMode

  Перечисление. Настройка отображения :term:`футера <Футер>` группы.

  .. warning:: |not_supported|

  .. pas:attribute:: gfmVisibleWhenExpanded

    Отображать только для развёрнутых узлов.

  .. pas:attribute:: gfmAlwaysVisible

    Отображать для всех узлов.



TbtkGroupSummaryPosition
........................

.. pas:class:: TbtkGroupSummaryPosition

  Перечисление. Положение промежуточных итогов.

  .. warning:: |not_supported|

  .. pas:attribute:: gspHeader

    Отображать промежуточные итоги в заголовке группы.

  .. pas:attribute:: gspFooter

    Отображать промежуточные итоги в :term:`футере <Футер>` группы.