.. _operation_props:

Свойства операции
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. attention::

   Содержимое статьи устарело. Смотрите описания свойств в справочнике метаданных,
   которого ещё не существует на данном этапе реорганизации документации.

.. btk:operprop:: Active

  :title: Флаг активности операции.

  Если операция не активна, она не отображается на :term:`панелях управления<Панель управления>`
  и :term:`меню`, не может быть выполнена из кода.

  .. attention::
    Если в метаданных указано значение false, соответствующие узлы кнопок и пунктов меню не создаются.
    Следовательно, такие кнопки и пункты меню не возможно сделать видимыми из кода.

  .. seealso::
    :java:meth:`CoreOper.isActive()<ru.bitec.gtk.core.gl.selection.CoreOper.isActive()>`

.. btk:operprop:: Enabled

  :title: Флаг включенности операции на всех :term:`панелях управления<Панель управления>` и :term:`меню`.

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

  .. seealso::
    :java:meth:`CoreOper.isEnabled()<ru.bitec.gtk.core.gl.selection.CoreOper.isEnabled()>`

.. btk:operprop:: Visible

  :title: Флаг видимости операции на всех на :term:`панелях управления<Панель управления>` и :term:`меню`.

  .. seealso::
    :java:meth:`CoreOper.isVisible()<ru.bitec.gtk.core.gl.selection.CoreOper.isVisible()>`

  .. versionadded:: AS 1.17

.. btk:operprop:: AdminVisible

  :title: Флаг видимости операции, определённый системой администрирования.

  .. attention::
    | При значении false, свойство имеет больший приоритет, чем :btk:operprop:`Visible`.
    | При значении true, приоритетом не обладает.

  .. attention::
    Если система администрирования установила значение false, соответствующие узлы кнопок и пунктов меню не создаются.
    Следовательно, такие кнопки и пункты меню не возможно сделать видимыми из кода.

  .. seealso::
    :java:meth:`CoreOper.isAdminVisible()<ru.bitec.gtk.core.gl.selection.CoreOper.isAdminVisible()>`

.. btk:operprop:: AdminEnabled

  :title: Флаг видимости операции, определённый системой администрирования.

  .. attention::
    | При значении false, свойство имеет больший приоритет, чем :btk:operprop:`Enabled`.
    | При значении true, приоритетом не обладает.

  .. seealso::
    :java:meth:`CoreOper.isAdminEnabled()<ru.bitec.gtk.core.gl.selection.CoreOper.isAdminEnabled()>`

.. btk:operprop:: Order

    :title: Порядковый номер операции. Свойство управляет положением операции на панели управления, в меню, и прочих контролах управления.

    .. attention::
        | Значение по умолчанию равно ``0``

    .. note::
        | **Правила порядка отображения операций:**
        | * по свойству ``Order`` (по возрастанию);
        | * если значения ``Order`` совпадают, порядок операций будет соответствовать порядку следования операций в списке операций в метаданных;
        | * для :term:`размножаемых операций <Размножаемые (клонируемые) операции>` значение задается, полем ``nOrder`` запроса :btk:operprop:`CloneQuery`.

    .. seealso::
        :java:field:`order<ru.bitec.gtk.core.gl.meta.pojo.opers.Operation.order>`


.. btk:operprop:: CloneQuery

    :title: Свойство предназначено для создания :term:`размножаемых операций <Размножаемые (клонируемые) операции>`.

    Операция, для которой определено данное свойство, определяется как :term:`клонирующая <Клонирующая операция>`.

    Свойство может содержать:
        * Имя выборки (имя выборки с отображением (через точку)), которая содержит запрос.
        * Текст SQL запроса. Операции создаются из записей, полученных при выполнении запроса.
            Следующие поля запроса управляют свойствами операций:

            Обязательные поля:
                * ``sName`` - имя операции. Обязательное поле. Имя должно быть уникальным в пределах выборки.
            Необязательные поля:
                * ``sCaption`` - заголовок операции. Если значения нет, оно берется из :term:`клонирующей операции<Клонирующая операция>`
                * ``sDescription`` - описание операции (всплывающая подсказка).
                * ``nImageIndex`` - номер картинки для операции. Если значения нет, оно берется из :term:`клонирующей операции<Клонирующая операция>`
                * ``sShotCut`` - :ref:`горячая клавиша<gs3_shortcuts>`. (Строка вида :kbd:`Shift+Ctrl+1`).
                * ``sHeadOperation`` – имя родительской операции. Для корневых операций должно содержать null. Если значения нет, оно берется из :term:`клонирующей операции<Клонирующая операция>`
                * ``sVisualStyleName`` – имя стиля, с которым будет отображаться наименование операции (только для компонента NavBar).
                * ``nOrder`` - номер операции для сортировки при отображении операции в меню, на панели управления, и прочих контролах управления. (см.: :btk:operprop:`Order`)

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

    .. seealso::

        :java:field:`cloneQuery<ru.bitec.gtk.core.gl.meta.pojo.opers.Operation.cloneQuery>`