.. _frame_properties:

Основные
===========================

.. underconstruction:: 
    Пока описаны не все свойства

.. btk:frameprop:: commentAttribute

    :title: Атрибут, информирующий о наличии комментариев
    :frames:  

        * :class:`Table`
            - :class:`Grid`
            - :class:`Tree`
            - :class:`Gantt`

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

    Значение по умолчанию: **sAttrNote#**.

    Формат значений атрибута:

    - Названия атрибутов с комментариями перечисляются через ``;``, после названия атрибута можно через вертикальную черту ``|`` задать цвет маркера подсказки.
      Маркер подсказки отображается в правом верхнем углу ячейки. Возможные значения цвета:

        #. Цвет в формате RGB (пример: $00FF00);

            .. note:: 

                RGB в дельфи-стиле, то есть слева направо: первый байт - синий, второй - зелёный, третий - красный

        #. Имя стиля, из которого необходимо использовать цвет фона (пример: Btk_DisabledGridGroupStyle). 
           Для использования символов ``;``, ``|`` и ``\`` в имени стиля их требуется экранировать с помощью ``\``;

        #. Ничего не указано. В этом случае маркер рисуется красным.

        .. note::

            Если в тексте цвета встречается несколько неэкранированных символов ``|``, то в качестве цвета будет использоваться подстрока от первого такого символа до второго


    .. code-block:: text
        :caption: Пример значения атрибута

        attrName1|$00FF00;attrName2|Btk_DisabledGridGroupStyle;attrName3

    .. seealso::

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

    .. versionadded:: AS 1.19

.. btk:frameprop:: commentTextAttribute

    :title: Атрибут, содержащий текст комментариев
    :frames:  

        * :class:`Table`
            - :class:`Grid`
            - :class:`Tree`
            - :class:`Gantt`

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

    Значение по умолчанию: **sAttrNoteText#**.

    Формат значений атрибута:

    - Названия атрибутов с комментариями перечисляются через ``;``, после названия атрибута через вертикальную черту ``|`` указывается текст комментария.
      Для использования символов ``;``, ``|`` и ``\`` в тексте комментария их требуется экранировать с помощью ``\``. Пустой текст комментария (``attr|;``) не считается ошибкой.

    .. note::

        Если в тексте комментария встречается несколько неэкранированных символов ``|``, то во всплывающей подсказке будет отображаться подстрока от первого такого символа до второго.
        Пример: Для текста ``attr|этот текст попадёт в подсказку|а этот не попадёт`` всплывающей подсказкой будет ``этот текст попадёт в подсказку``

    .. code-block:: text
        :caption: Пример значения атрибута

        attrName1|Комментарий для первого атрибута;attrName2|Комментарий для второго атрибута с экранированными символами '\;', '\|' и '\\'

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

        ,'nDuplicates|'
        ||decode(t.nDuplicates
            ,4, 'Есть остатки на дубликатах ТМЦ'
            ,0, 'Есть дубликаты ТМЦ'
            ,1, 'Нет дубликатов'
        ) sAttrNoteText#
        ,'nDuplicates' sAttrNote#

    ``nDuplicates`` - атрибут с картинкой, к которому нужен хинт

    .. seealso::

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

    .. versionadded:: AS 1.19

.. btk:frameprop:: gridComponentLib

    :title: Библиотека UI компонента
    :frames:  

        * :class:`Table`
            - :class:`Grid`
            - :class:`Tree`
            - :class:`Gantt`
    :type: 

    Задает какая UI библиотека будет использоваться для отображения грида в интерфейсе.

    .. todo:: Описание ждем домена xsd от Владимира.

    .. seealso::

        Свойство фрейма  :term:`Oracle решения<Oracle решение>`: :btk:frameprop:`GridComponentLib`

    .. versionadded:: AS 1.19

.. btk:frameprop:: dragDrop.rows.isDragEnabled

    :title: Перетаскивание строк с фрейма
    :frames:  
        * :class:`Table`
            - :class:`Grid`
            - :class:`Tree`
            - :class:`Gantt` 

    Задаёт возможность перетаскивать строки с фрейма

    .. seealso:: :ref:`Перетаскивание (Drag & Drop) строк списка мышью<drag_and_drop_rows>`

.. btk:frameprop:: dragDrop.rows.isDropEnabled

    :title: Перетаскивание строк на фрейм
    :frames:  
        * :class:`Table`
            - :class:`Grid`
            - :class:`Tree`
            - :class:`Gantt`

    Задаёт возможность перетаскивать строки на фрейма

    .. seealso:: :ref:`Перетаскивание (Drag & Drop) строк списка мышью<drag_and_drop_rows>`