Методы

Методы #

CDbl #

Поддержка в версии: старше или равно 34.24.03.32.

Overview
Преобразует объект в вещественное число Double. Если Obj является строковым объектом, то в качестве разделителя дробной части допускается использование точки и запятой.

CDbl  ( Obj  Variant  ) : String 

Возвращаемое значение
Тип: String
Число Double или null, если преобразование невозможно.

Параметры

VBScript

ag.MsgBox ag.CDbl("12,3")
ag.MsgBox ag.CDbl("12.3")

almaGRID API

DateStrToDbl #

Поддержка в версии: старше или равно 34.24.03.32.

Overview
Преобразует строковое представление даты/вренени в объект в вещественное число Double.

DateStrToDbl  ( DateStr  String  ) : String 

Возвращаемое значение
Тип: String
Число Double или null, если преобразование невозможно.

Параметры

VBScript

ag.MsgBox ag.DateStrToDbl("02.10.2023")
ag.MsgBox ag.DateStrToDbl("02.10.2023 16:30:25")
ag.MsgBox ag.DateStrToDbl("16:30:25")

ag.MsgBox ag.FormatDate(ag.DateStrToDbl("02.10.2023 16:30:25"), "yyyy-MMM-dd, hh:mm")

almaGRID API

FormatDate #

Поддержка в версии: старше или равно 34.24.2.0.

Overview
Преобразует значение даты Expression в строку в соответствии с заданным форматом.

FormatDate  ( Expression  Variant , FormatString  Variant  ) : String 

Возвращаемое значение
Тип: String
Строковое представление даты.

Параметры

Часто используемые описатели форматов

Источник: Строки форматов даты и времени.

VBScript

ag.MsgBox ag.FormatDate(Date1, "yyyy-MM-dd hh:mm:ss.ffff")

almaGRID API

FormatNumber #

Поддержка в версии: старше или равно 34.24.2.0.

Overview
Преобразует численное значение Expression в строку в соответствии с заданным форматом.

FormatNumber  ( Expression  Variant , FormatString  Variant  ) : String 

Возвращаемое значение
Тип: String
Строковое представление числа.

Параметры

Часто используемые описатели форматов

Источник: Строки числовых форматов.

almaGRID API

If #

Поддержка в версии: старше или равно 34.24.2.0.

Overview
Возвращает значение Expression, IsNothingOrTruePart или FalsePart в зависимости от результата провери условия Expression.

If  ( Expression  Variant , IsNothingOrTruePart  Variant , FalsePart  Variant  ) : Variant 

Возвращаемое значение
Тип: Variant

(1) Если не задан FalsePart, то возвращает значение Expression, если оно отличается от null, или IsNothingOrTruePart в противном случае.

(2) Если задан FalsePart, то возвращает значение IsNothingOrTruePart если Expression равно True или значение FalsePart в противном случае.

Параметры

VBScript

Set Value = Nothing
ag.MsgBox ag.If(Value, "значение 'Null'")
ag.MsgBox ag.If(2 > 3, "это правда", "это ложь")

almaGRID API

IIf #

Overview
Возвращает значение TruePart, если Expression имеет значение True, или FalsePart в противном случае.

IIf  ( Expression  Boolean , TruePart  Variant , FalsePart  Variant  ) : Variant 

Возвращаемое значение
Тип: Variant
Значение TruePart, если Expression имеет значение True, или FalsePart в противном случае.

Параметры

Комментарии

Функця IIf всегда оценивает обе части TruePart и FalsePart, хотя возвращает только одну из них. По этой причине следует внимательно следить за появлением нежелательных побочных эффектов. Например, если вычисление выражения FalsePart приводит к ошибке деления на ноль, возникает ошибка, даже если значение Expression равно True.

VBScript

ag.MsgBox ag.IIf(2 > 3, "Истина", "Ложь")

almaGRID API

InputBox #

Overview
Отображает приглашение в диалоговом окне, ждет, пока пользователь введет текст или нажмет кнопку 'Отменить', и возвращает строку с содержимым текстового поля или строку '{Cancel}' если пользователь нажал на кнопку 'Отменить'.

InputBox  ( Prompt  String , [Title  String  = '' ], [DefaultValue  Object  = '' ], [XPos  Integer  = -1 ], [YPos  Integer  = -1 ] ) : String 

Возвращаемое значение
Тип: String
Строка с содержимым текстового поля или строка '{Cancel}' если пользователь нажал на кнопку 'Отменить'.

Параметры

VBScript

'Запрашиваем у пользователя значение
N = ag.InputBox("Введите наибольшую глубину дочерних уровней (от 2 до 5)","", 5)

almaGRID API

Max #

Overview
Возвращает максимальное значение или null, если максимальное значение вычислить не удается.

Max  ( Value1  Variant , [Value2  Variant  = null ] ) : Variant 

Возвращаемое значение
Тип: Variant
Максимальное значение или null.

Параметры

VBScript

ag.MsgBox ag.Max(3, 2)
ag.MsgBox ag.Max(Array(1, 3, 2))
ag.MsgBox ag.Max(ag.app.NewObject("List", Array(1, 3, 2)))

almaGRID API

Min #

Overview
Возвращает минимальное значение или null, если минимальное значение вычислить не удается.

Min  ( Value1  Variant , [Value2  Variant  = null ] ) : Variant 

Возвращаемое значение
Тип: Variant
Минимальное значение или null.

Параметры

VBScript

ag.MsgBox ag.Min(3, 2)
ag.MsgBox ag.Min(Array(1, 3, 2))
ag.MsgBox ag.Min(ag.app.NewObject("List", Array(1, 3, 2)))

almaGRID API

MsgBox #

Overview
Выводит сообщение в диалоговом окне, ожидает нажатия кнопки пользователем и возвращает значение типа Integer, которое указывает, какая кнопка была нажата пользователем.

MsgBox  ( Prompt  Variant , [MsgBoxStyle  Integer  = 0 ], [Title  String  = '' ] ) : Integer 

Возвращаемое значение
Тип: Integer
Значение, которое указывает, какая кнопка была нажата:

vbOk = 1 - Нажата кнопка ОК.

vbCancel = 2 - Нажата кнопка Отмена.

vbYes = 6 - Нажата кнопка Да.

vbNo = 7 - Нажата кнопка Нет.

Параметры

VBScript

'Запрашиваем подтверждение пользователя на переход к следующему действию
if (ag.MsgBox("Перейти к выбору из дерева тегов?", vbQuestion or vbYesNo)) = vbYes Then
  'Показываем пользователю ветвь дерева тегов, растущую из BaseTagPath и принимаем его выбор
  s = ag.tags.inputFromTree(BaseTagPath, "", "Выберите тег из ветви")

  'выводим идентификатор тега, выбранного пользователем
  ag.MsgBox s
End If

almaGRID API

Objectify #

Overview
Возвращает объект, созданный из JSON-строки.

Objectify  ( Str  String , [TypeName  String  = '' ] ) : Variant 

Возвращаемое значение
Тип: Variant
Объект.

Параметры

Комментарии

Метод создает объект, содержащий:

1. Переменные или константы простых типов данных (String, Integer, Double, Boolean, etc.),
2. Одномерные массивы,
3. Экземпляры типов:
   • System.Collections.HashTable — Коллекция пар ‘Ключ’-‘Значение’, которые упорядочены по хэш-коду ключа.
   • System.Collections.SortedList — Коллекция пар ‘Ключ’-‘Значение’, упорядоченых по ключам.
   • System.Collections.ArrayList — Массив с динамическим увеличением размера.

В качестве ключей в экземплярах System.Collections.HashTable и System.Collections.SortedList используются переменные или константы простых типов данных.

В других случаях может возникать ошибка и/или возвращаемый объект может принимать значение null.

VBScript

'создаем структуру данных
Set objSL = ag.app.NewObject("SortedList")
objSL.Add "SL-1", "Стол"
objSL.Add "SL-0", Array(33,"Шкаф")
objSL.Add "SL-2", objQ              'Объект objQ не определен


Set objAL = ag.app.NewObject("ArrayList")
objAL.Add 1
objAL.Add "2"
objAL.Add 3.3
objAL.Add objSL

fruit = "Груша"

Set objHT = ag.app.NewObject("HashTable")
objHT.Add "HT-0", objAL
objHT.Add "HT-1", Array(11,"Яблоко")
objHT.Add "HT-2", fruit

'код выше можно записать короче:
Set objSL = ag.app.NewObject("SortedList", Array("SL-1", "Стол", "SL-0", Array(33,"Шкаф"), "SL-2", objQ))
Set objAL = ag.app.NewObject("ArrayList", Array(1, "2", 3.3, objSL))
Set objHT = ag.app.NewObject("HashTable", Array("HT-0", objAL, "HT-1", Array(11,"Яблоко"), "HT-2", fruit))


'получаем структуру данных в виде строки и выводим ее
Str = ag.Stringify(objHT, "<prm typeNameHandling='true'/>")
ag.MsgBox "1: " & Str                                             

'восстанавливаем структуру данных из строки и выводим ее элементы
Set Res = ag.app.Objectify(Str)

ag.MsgBox "2: " & Res("HT-0")(3)("SL-1")                          
ag.MsgBox "3: " & Res("HT-1")(1)                                  
ag.MsgBox "4: " & Res("HT-2")                                     

set Obj1 = Res("HT-0")(3)
ag.MsgBox "5: " & Obj1.GetKey(0) & vbTab & Obj1.GetByIndex(0)(1)  

'Результат:
'
'1:{
'    "$type": "System.Collections.Hashtable, mscorlib",
'    "HT-0": {
'        "$type": "System.Collections.ArrayList, mscorlib",
'        "$values": [
'            1,
'            "2",
'            3.3,
'            {
'                "$type": "System.Collections.SortedList, mscorlib",
'                "SL-0": {
'                    "$type": "System.Object[], mscorlib",
'                    "$values": [
'                        33,
'                        "Шкаф"
'                    ]
'                },
'                "SL-1": "Стол",
'                "SL-2": null
'            }
'        ]
'    },
'    "HT-2": "Груша",
'    "HT-1": {
'        "$type": "System.Object[], mscorlib",
'        "$values": [
'            11,
'            "Яблоко"
'        ]
'    }
'}
'2: Стол
'3: Яблоко
'4: Груша
'5: SL-0	Шкаф

almaGRID API

Parse #

Overview
Создает именованный список из строки параметров имя/значение.

Parse  ( Str  String  ) : Dictionary  

Возвращаемое значение
Тип: Dictionary
Именованный список пар Ключ—Значение, полученный из строки параметров имя/значение.

Параметры

VBScript

set dict1 = ag.Parse(Str)
set dict2 = ag.Parse("Тип=""Поток""; Flow, m3/hour=2.4")
set dict2 = ag.Parse("Тип=Поток; Flow, m3/hour=2.4")

almaGRID API

Stringify #

Overview
Возвращает значение, преобразованное в JSON-строку.

Stringify  ( Var  Variant , [PrmXML  String  = '' ] ) : String 

Возвращаемое значение
Тип: String
JSON-строка.

Параметры

VBScript

Set dict2 = ag.app.NewObject("Dictionary", Array("Cat", 23, "Dog", 33))
ag.MsgBox ag.Stringify(dict2)

[ag_vSpace