AskPeriod

From SunFlurry wiki
Jump to: navigation, search
  AskPeriod (Визуальные функции)
Объект:Функции общего назначения
Статус разработки: Реализована
Тип:Функция
Обращение к БД:Нет
Исключения:Невозможно превратить в дату, строку, число
Визуальность:Да

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

Синтаксис

AskPeriod(<Начальная дата периода (DATE)>,<Конечная дата периода (DATE)>,<Заголовок диалога (STRING)>,<Тип ограничения при выборе периода (INT)>=0):<Пользователь нажал на ОК (INT)>

Аргументы

  • <Начальная дата периода (DATE) - (возможен аргумент-переменная (ByRef)) Переменная задающая и получающая начальную дату периода
  • <Конечная дата периода (DATE) - (возможен аргумент-переменная (ByRef)) Переменная задающая и получающая конечную дату периода
  • <Заголовок диалога (STRING)> - (необязательный аргумент) Заголовок диалога выбора периода
  • <Тип ограничения при выборе периода (INT)> - (необязательный аргумент) Задает режим ограничения диалога, возможные значения:
    • 0 (по умолчанию) -- ограничения на период не накладываются.
    • 1 -- разрешается выбирать только периоды, состоящие из полных недель
    • 2 -- разрешается выбирать только периоды, состоящие из полных месяцев
    • 3 -- разрешается выбирать только периоды, состоящие из полных кварталов
    • 4 -- разрешается выбирать только периоды, состоящие из полных лет
    • 5 -- разрешается выбирать только период, состоящий из одной недели
    • 6 -- разрешается выбирать только период, состоящий из одного месяца
    • 7 -- разрешается выбирать только период, состоящий из одного квартала
    • 8 -- разрешается выбирать только период, состоящий из одного года

Возвращаемое значение

Возвращает 1, если пользователь нажал на ОК, иначе возвращает 0


Примеры

//Блок выбирает период, состоящий из полных месяцев
НДата:=Date();
КДата:=НДата;
If not AskPeriod(НДата,КДата,"Выберите месяцы формирования отчета:",2) Then
  Exit;
EndIf;
Message("Выбран период с "+НДата+" по "+КДата);