.. _api_reference_dialog_box:

===============================================================================================================
Диалоговое окно
===============================================================================================================

Предоставляет методы для отображения наложенного контента. Позволяет использовать страницы ``sys_page``, которые могут, создавать, менять или удалять записи, а так же запрашивать внешние скрипты.

.. figure:: ../../image/dialog_box.png
   :alt: Диалоговое окно

   Пример диалогового окна


**DialogCtrl**

DialogCtrl создает новый экземпляр UiDialogWindow

Параметры:

==================== ==================== ====================================
Параметр             Тип значения         Описание
==================== ==================== ====================================
pageName             String               Имя страницы (объект ``sys_page``) для загрузки диалогового окна
values               Map                  Начальные значения для свойств в диалоговом окне. Словарь ключ-значение: *ключ* - идентификатор свойства, *значение* - начальное значение свойства
==================== ==================== ====================================


**UIDialogWindow**

API UIDialogWindow предоставляет методы для отображения диалога в текущем окне и фрейме.

**Методы**

**show()**

Открыть диалоговое окно

.. code-block:: javascript

    var dialog = dialogWindow.create("pagename");
    dialog.show();


**setWidth(String width)**

==================== ==================== ====================================
Параметр             Тип значения         Описание
==================== ==================== ====================================
width                String               Устанавливает ширину окна. Пример: `800px` или `50%`
==================== ==================== ====================================

**setHeight(String height)**

==================== ==================== ====================================
Параметр             Тип значения         Описание
==================== ==================== ====================================
height               String               Устанавливает высоту окна. Пример: `800px` или `50%`
==================== ==================== ====================================

**setTitle(String title)**

==================== ==================== ====================================
Параметр             Тип значения         Описание
==================== ==================== ====================================
title                String.              Устанавливает заголовок окна
==================== ==================== ====================================

Пример:

.. code-block:: javascript

    var dialog = dialogWindow.create("pagename");
    dialog.setTitle("My dialog");

**close()**

Закрыть диалоговое окно.

**onOk(Ok okCall)**

Функция вызова, когда пользователь нажимает кнопку «ОК». Вы можете вернуть false, чтобы предотвратить закрытие диалогового окна.

==================== ====================================
Параметр             Описание
==================== ====================================
okCall               Функция обратного вызова при ОК
==================== ====================================

Пример:

.. code-block:: javascript

    dialog.onOk(function (map) {
        if (map.get("ref1") == null) {
            uiUtils.showNotificationError("Select ref"); // show message
            return false; // prevent dialog to close
        }
        // set properties and close the dialog
        object.setProperty("str", map.get("string1"));
        object.setProperty("integer", map.get("int1"));
    });

**onCancel(Cancel cancelCall)**

Функция вызова, когда пользователь нажимает кнопку «Отмена».

Пример:

.. code-block:: javascript

    dialog.onCancel(function () {
        uiUtils.showNotification("Cancel");
    });

---------------



:ref:`api_reference_create_dialog_box`

В платформе DBVIM вы можете создавать отличные диалоговые окна, которые позволяют расширить функционал пользовательского интерфейса.