opisanie_funkciy_konfiguracii_terrasoftx

advertisement
Описание функций конфигурации Terrasoft
Скрипт: scr_DB
Имя функции
AddBlobDataField
AddBoolDataField
AddCalcDataField
AddCompareFilter
AddCompareFilterByFieldName
AddCompareFilterParamExpression
Описание
Добавить BLOB-поле в набор данных
Входящие параметры:
DataFields - коллекция полей датасета;
DataFieldName - имя добавляемого поля
(должно совпадать с одной из колонок
SelectQuery, связанного с датасетом);
DataFieldCaption - заголовок добавляемого
поля;
IsDisplayField - является ли полем для
отображения в полях-справочниках
Добавить булевское поле в набор данных
Входящие параметры:
DataFields - коллекция полей датасета;
DataFieldName - имя добавляемого поля
(должно совпадать с одной из колонок
SelectQuery, связанного с датасетом);
DataFieldCaption - заголовок добавляемого
поля;
IsDisplayField - является ли полем для
отображения в полях-справочниках
Добавить расчетное поле в набор данных
Входящие параметры:
DataFields - коллекция полей датасета;
DataFieldName - имя добавляемого поля
(должно совпадать с одной из колонок
SelectQuery, связанного с датасетом);
DataFieldCaption - заголовок добавляемого
поля;
SQLDataType - тип поля (см. в scr_SysEnums
константы _SQLDataTypeEnum)
SQLSize - размер поля;
SQLPrecision - точность дробной части, если это
дробное поле;
IsDisplayField - является ли полем для
отображения в полях-справочниках
Добавить фильтр сравнения в запрос (пустой)
Входящие параметры:
Filters - коллекция фильтров SelectQuery
Добавить фильтр сравнения в SelectQuery по
полю датасета
Входящие параметры:
SelectQuery - экземпляр SelectQuery;
FieldName - имя поля датасета;
ParameterType - тип параметра (см. в
scr_SysEnums константы _ParamDataTypeEnum)
Value - значение условия
Добавить параметр сравнения в фильтр
сравнения
AddConstColumn
AddDateTimeDataField
AddEnumDataField
AddFieldExpression
AddFieldFieldCompareFilter
Входящие параметры:
Filters - коллекция фильтров SelectQuery;
Filter - фильтр, в котором добавляется
подзапрос;
Parameter - параметр
Добавить колонку-константу в SelectQuery
Входящие параметры:
Columns - коллекция колонок;
DataType - тип данных колонки;
ColumnAlias - алиас колонки;
IsEnabled - включать ли колонку;
CanDisabled - всегда ли должна быть включена
колонка
Добавить поле дата/время в набор данных
Входящие параметры:
DataFields - коллекция полей датасета;
DataFieldName - имя добавляемого поля
(должно совпадать с одной из колонок
SelectQuery, связанного с датасетом);
DataFieldCaption - заголовок добавляемого
поля;
IsDisplayField - является ли полем для
отображения в полях-справочниках
Добавить поле перечисления в набор данных
Входящие параметры:
DataFields - коллекция полей датасета;
DataFieldName - имя добавляемого поля
(должно совпадать с одной из колонок
SelectQuery, связанного с датасетом);
DataFieldCaption - заголовок добавляемого
поля;
IsDisplayField - является ли полем для
отображения в полях-справочниках;
EnumCode - имя перечисления-источника
Добавление выражения в условие фильтра
Входящие параметры:
Filters - коллекция фильтров;
Filter - фильтр, в котором нужно добавить
условие;
Field - поле, по которому добавляется условие;
FieldTableAlias - алиас таблицы, к которой
принадлежит поле условия
Добавить фильтр сравнения поля с другим
полем в запрос
Входящие параметры:
Filters - коллекция фильтров;
TestExpressionField - поле в левой части условия
сравнения;
TestExpressionFieldTableAlias - алиас таблицы
для левой части условия;
ValueExpressionField - поле правой части
условия сравнения;
ValueExpressionFieldTableAlias - алиас поля для
AddFieldParamCompareFilter
AddFieldToDataset
AddFloatDataField
AddGeneralColumn
AddGeneralColumnByFromTableFieldName
AddIDFilter
правой части условия;
CompareOperator - оператор сравнения (см. в
scr_SysEnums перечисление
_CompareOperatorTypeEnum)
Добавить фильтр сравнения с параметром в
запрос
Входящие параметры:
Filters - коллекция фильтров;
TestExpressionField - добавить поле в левую
часть условия сравнения;
FieldTableAlias - алиас поля для левой части
условия;
ValueExpressionParameter - параметр правой
части условия сравнения;
CompareOperator - оператор сравнения (см. в
scr_SysEnums перечисление
_CompareOperatorTypeEnum)
Добавить копию поля датасета
Входящие параметры:
DataField - экземпляр поля, которое копируется;
Dataset - экземпляр датасета
Добавить дробное поле в набор данных
Входящие параметры:
DataFields - коллекция полей датасета;
DataFieldName - имя добавляемого поля
(должно совпадать с одной из колонок
SelectQuery, связанного с датасетом);
DataFieldCaption - заголовок добавляемого
поля;
Precision - точность дробной части;
IsDisplayField - является ли полем для
отображения в полях-справочниках
Добавить основную колонку в SelectQuery
Входящие параметры:
Select - Select из SelectQuery, в который
добавляется колонка;
Field - поле таблицы;
ColumnAlias - алиас колонки;
IsEnabled - включить/выключить эту колонку;
CanDisabled - может ли быть колонка отключена
Добавить основную колонку в SelectQuery по
полю таблицы
Входящие параметры:
Select - Select из SelectQuery, в который
добавляется колонка;
FieldName - имя поля в таблице;
ColumnAlias - алиас колонки;
IsEnabled - включить/выключить эту колонку;
CanDisabled - может ли быть колонка отключена
Добавить фильтр по ID в SelectQuery (без
установки значения)
Входящие параметры:
SelectQuery - экземпляр SelectQuery
AddIncludeFilter
AddIncludeValuesList
AddIntegerDataField
AddIsNullFilter
AddItemInGroup
AddLikeFieldFilter
AddLookupDataField
Добавить include-фильтр без значений в
SelectQuery
Входящие параметры:
SelectQuery - экземпляр SelectQuery;
FieldName - имя поля датасета;
FilterName - имя фильтра
Добавить список ID-значений в include-фильтр
Входящие параметры:
IncludeFilter - экземпляр include-фильтра;
Parameters - коллекция параметров;
ValuesList - массив значений
Добавить целочисленное поле в набор данных
Входящие параметры:
DataFields - коллекция полей датасета;
DataFieldName - имя добавляемого поля
(должно совпадать с одной из колонок
SelectQuery, связанного с датасетом);
DataFieldCaption - заголовок добавляемого
поля;
TextLength - размер поля;
IsDisplayField - является ли полем для
отображения в полях-справочниках
Добавить фильтр проверки на NULL в
SelectQuery
Входящие параметры:
Filters - коллекция фильтров;
Field - экземпляр поля
Добавить запись в группу
Входящие параметры:
WorkspaceGroupsDataset - экземпляр датасета
групп раздела;
ItemInGroupDatasetUSI - имя датасета-развязки
(например, ds_AccountInGroup), в который
будет добавляться запись;
KeyValue - ID добавляемой записи;
FilterName - имя фильтра, по которому ищется
запись;
SilentAdd - выводить вопрос о добавлении в
группу или нет
Добавить contains-фильтер в SelectQuery
Входящие параметры:
Select - экземпляр селекта, в который нужно
добавить фильтр;
FilterCode - код фильтра;
TestFieldName - код поля;
LikeType - тип оператора like (см. в scr_SysEnums
перечисление _LikeTypeEnum)
FilterSet - экземпляр набора фильтров
Добавить поле-справочник в набор данных
Входящие параметры:
DataFields - коллекция полей датасета;
DataFieldName - имя добавляемого поля
(должно совпадать с одной из колонок
AddParamExpression
AddParameter
AddQueryCompareFilter
AddQueryParameter
AddSelectFilterExpression
AddSelectQueryCompareFilter
AddStringDataField
SelectQuery, связанного с датасетом);
DataFieldCaption - заголовок добавляемого
поля;
IsDisplayField - является ли полем для
отображения в полях-справочниках;
LookupDatasetCode - имя датасета-источника;
DisplayColumn - колонка SelectQuery для
отображения
Добавить параметр к выражению includeфильтра
Входящие параметры:
FilterExpressions - коллекция выражений
include-фильтра;
Parameter - экземпляр параметра
Добавить параметр и присвоить ему значение
Входящие параметры:
Parameters - коллекция параметров;
ParamDataType - тип параметра (см. в
scr_SysEnums константы _ParamDataTypeEnum);
ParamValue - значение параметра
Добавить фильтр сравнения в SelectQuery
Входящие параметры:
Filters - коллекция фильтров;
Code - имя фильтра;
Field - экземпляр поля таблицы;
Parameter - экземпляр параметра;
CompareOperatorType - оператор сравнения;
TableAlias - алиас таблицы
Добавить параметр в SelectQuery
Входящие параметры:
Parameters - коллекция параметров;
Name - имя параметра;
DataType - тип параметра;
ParamValue - значение параметра
Добавить подзапрос в фильтре
Входящие параметры:
Filter - фильтр, в котором добавляется
подзапрос;
SelectFromTable - название таблицы;
TableAlias - алиас таблицы
Добавить в SelectQuery фильтр сравнения
Входящие параметры:
SelectQuery - экземпляр SelectQuery;
FieldName - название поля, по которому хотим
сформировать фильтр;
CompareOperatorType - оператор сравнения (см.
_CompareOperatorTypeEnum в скрипте
scr_SysEnums)
Добавить строковое поле в набор данных
Входящие параметры:
DataFields - коллекция полей датасета;
DataFieldName - имя добавляемого поля
(должно совпадать с одной из колонок
AddTestSubqueryExpression
AddValuesExpressionsParameter
AppendRecordInDataset
ApplyDatasetFilter
ApplyDatasetGroupIDFilter
ApplyDatasetIDFilter
SelectQuery, связанного с датасетом);
DataFieldCaption - заголовок добавляемого
поля;
TextLength - длина текста;
IsDisplayField - является ли полем для
отображения в полях-справочниках;
IsSearchField - является ли полем для поиска в
полях-справочниках
Добавить подзапрос в фильтре (так
называемый TestSubquery)
Входящие параметры:
Filters - коллекция фильтров;
Filter - фильтр, в котором добавляется
подзапрос
Добавление параметра в SelectQuery с
присвоением значения
Входящие параметры:
ValuesExpressions - коллекция ValuesExpressions
параметров SelectQuery;
Parameters - коллекция параметров SelectQuery;
DataType - тип данных параметра (см.
_ParamDataTypeEnum из скрипта scr_SysEnums);
ParamValue - значение параметра
Добавление записи в датасет
Входящие параметры:
Dataset - экземпляр датасета;
ID - ID записи;
FieldNames - массив имен полей;
FieldValues - массив значений;
DoNotDisableEvents - не отключать события
датасета при внесении изменений
Применить фильтр датасета по значению
Входящие параметры:
Dataset - экземпляр датасета;
FilterName - название фильтра;
ParamValue - значение, по которому хотим
отфильтровать набор данных;
Enabled - включить/выключить фильтр
Применить фильтр по группе (для наборов
данных менеджера групп)
Входящие параметры:
ParentDataset - датасет групп объекта;
ChildDataset - датасет объекта (обычно датасет
раздела);
ParentIDFieldName - название поля связи группы
с родительской группой в датасете групп
Применить фильтр датасета по полю значению
в поле ID
Входящие параметры:
Dataset - экземпляр Dataset;
IDValue - значение, по которому хотим
отфильтровать набор данных;
Enabled - включить/выключить фильтр
ApplyDatasetIncludeFilter
ApplyDatasetIsNullFilter
ApplyInsertSelectQueryIncludeFilter
ApplyQueryIncludeFilter
ApplySelectQueryFilter
ApplySelectQueryIncludeFilter
CommitTransaction
CopyDatasetAttributes
CopyDatasetRecordToDictionary
Применить include-фильтр Dataset-а
Входящие параметры:
Dataset - экземпляр Dataset;
FilterCode - имя применяемого фильтра;
ParamValues - массив значений параметров;
Enabled - включить/выключить фильтр;
Parameters - коллекция параметров SelectQuery
Применить ISNULL-фильтр на наборе данных
Входящие параметры:
Dataset - экземпляр датасета;
FilterName - имя применяемого фильтра;
Enabled - включить/выключить
Применить include-фильтр InsertSelectQuery
Входящие параметры:
InsertSelectQuery - экземпляр InsertSelectQuery;
FilterCode - имя применяемого фильтра;
ParamValues - массив значений параметров;
Enabled - включить/выключить фильтр
Применить include-фильтр в Select-е у
SelectQuery
Входящие параметры:
Query - экземпляр Select-а;
Filters - коллекция фильтров SelectQuery;
FilterCode - имя применяемого фильтра;
ParamValues - массив значений параметров;
Enabled - включить/выключить фильтр;
DataType - тип данных параметра (см.
_ParamDataTypeEnum из скрипта scr_SysEnums);
Parameters - коллекция параметров SelectQuery
Применить фильтр SelectQuery по значению
Входящие параметры:
SelectQuery - экземпляр SelectQuery;
FilterName - название фильтра;
ParamValue - значение, по которому хотим
отфильтровать набор данных;
Enabled - включить/выключить фильтр
Применить include-фильтр в SelectQuery
Входящие параметры:
SelectQuery - экземпляр SelectQuery;
FilterCode - имя применяемого фильтра;
ParamValues - массив значений параметров;
Enabled - включить/выключить фильтр;
DataType - тип данных параметра (см.
_ParamDataTypeEnum из скрипта scr_SysEnums);
Parameters - коллекция параметров SelectQuery
Выполнение подтверждения транзакции
Скопировать атрибуты одного датасета в другой
Входящие параметры:
Source - экземпляр датасета-источника;
Destination - экземпляр датасета-приемника
Копировать запись датасета в именованный
справочник
Входящие параметры:
CopyDictionaryToDatasetRecord
CopyFieldsData
CopyFullData
CopyMemoryDataset
CopyMemoryDatasetRowData
CopyRowData
CopyRowDataEx
CopyRowDataToDefValues
CopySubTree
Dataset - экземпляр датасета
Копировать данные из справочника в запись
датасета
Входящие параметры:
Dictionary - справочник;
Dataset - экземпляр датасета
Копирование указанного массива полей из
датасета в датасет
Входящие параметры:
SourceDataset - экземпляр датасета-источника;
DestinationDataset - экземпляр датасетаполучателя;
FieldNames - массив имен полей, по которым
идет проверка
Копирование всех записей из датасета в датасет
Входящие параметры:
SourceDataset - датасет-источник;
DestinationDataset - датасет-получатель
Копирование всех данных из одного
MemoryDataset-а в другой
Входящие параметры:
SourceDataset - датасет-источник;
DestinationDataset - датасет-получатель
Копирование одной записи из одного
MemoryDataset-а в другой
Входящие параметры:
SourceDataset - датасет-источник;
DestinationDataset - датасет-получатель
Копировать текущую запись датасета в другой
датасет
Входящие параметры:
SourceDataset - датасет-источник;
DestinationDataset - датасет-получатель
Копировать текущую запись датасета в другой
датасет (расширенный вариант)
Входящие параметры:
SourceDataset - датасет-источник;
DestinationDataset - датасет-получатель;
ExcludedFieldsList - справочник с полями,
которые не нужно копировать
Копирование данных в справочник (объект
'Scripting.Dictionary')
Входящие параметры:
SourceDataset - экземпляр датасета;
DefValues - экземпляр справочника
Копирование ветки датасета-иерархии ("ветки
дерева")
Входящие параметры:
SourceDataset - датасет-источник;
DestinationDataset - датасет-получатель;
ParentFieldName - имя родительского поля, в
котором хранится ссылка на родительскую
запись;
CopyTreeDetail
CreateConstColumn
CreateDataFieldByColumnAlias
CreateGeneralColumn
CreateParam
CreateSubselectColumn
DataTypeToParamDataType
DatasetToEnum
SourceParentID - ID копируемой записи;
DestinationParentID - ID записи, в которую
копируются данные вместе с вложениями
Копирование данных детали, представляющей
из себя "дерево"
Входящие параметры:
SourceDataset - датасет-источник;
DestinationDataset - датасет-получатель;
SourceParentItemIDFieldName - имя поля-ссылки
на родительскую запись датасета-источника;
DestinationParentItemIDFieldName - имя поляссылки на родительскую запись датасетаполучателя;
DestinationParentItemID - ID родительской
записи датасета-получателя
Создать колонку-константу SelectQuery
Входящие параметры:
Columns - коллекция колонок;
DataType - тип данных колонки;
ColumnAlias - алиас колонки;
IsEnabled - включать ли колонку;
CanDisabled - всегда ли должна быть включена
колонка
Создать поле набора данных по алиасу колонки
из SelectQuery
Входящие параметры:
Dataset - экземпляр датасета;
ColumnAlias - алиас колонки;
DataFieldType - тип поля датасета;
Caption - заголовок поля датасета
Создать основную колонку
Входящие параметры:
Columns - коллекция полей датасета;
Field - поле таблицы;
ColumnAlias - алиас колонки;
IsEnabled - включить/выключить эту колонку;
CanDisabled - может ли быть колонка отключена
Добавить параметр в коллекцию параметров
Входящие параметры:
Parameters - коллекция параметров;
ParamName - имя параметра;
ParamDataType - тип параметра (см. в
scr_SysEnums константы _ParamDataTypeEnum)
Создать колонку-подзапрос SelectQuery
Входящие параметры:
Columns - коллекция колонок
Получить тип параметра по типу поля датасета
Входящие параметры:
DataType - тип поля датасета
Создание перечисления на основе датасета
Входящие параметры:
DatasetUSI - USI датасета;
CaptionFieldName - поле датасета, из которого
DeleteChildRecords
DeleteDatasetRecord
DeleteParametersByValueExpressions
DeleteSubTree
DisableAllColumns
DisableSelectQueryColumns
DisableSelectQueryFirstLevelFilters
DoDragDropMemoryDatasetRow
берутся значения для отображения
Удалить дочерние данные
Входящие параметры:
DeleteQuery - экземпляр DeleteQuery;
ParentFieldName - имя родительского
ключевого поля;
ParentID - значение ключевого поля, по
которому происходит операция удаления
Удалить запись в наборе данных
Входящие параметры:
Dataset - экземпляр датасета
Удаление параметров по значениям
Входящие параметры:
Parameters - коллекция параметров SelectQuery;
ValuesExpressions - коллекция значений
ValuesExpressions в SelectQuery,
параметры которых нужно удалить из
коллекции параметров Parameters
Удалить ветвь "дерева"
Входящие параметры:
Dataset - экземпляр датасета;
KeyFieldName - поле-первичный ключ;
ParentFieldName - поле-связь с родительской
записью "дерева";
RootID - ID записи-узла ("корня");
KeepRoot - не удалять ли "корень"
Выключить все колонки SelectQuery
Входящие параметры:
Columns - коллекция колонок SelectQuery;
DisableOrder - флаг "убрать сортировку при
отключении колонки";
DoNotDisableIDColumn - флаг "не отключать
поле 'ID'"
Отключить все колонки SelectQuery за
исключением массива колонок
Входящие параметры:
SelectQuery - экземпляр SelectQuery;
ExceptColumnArray - массив алиасов колонок,
которые не будут отключены
Отключение фильтров первого уровня
вложения, т.е. фильтры у Exists-фильтров не
отключаются
Параметры:
SelectQuery - экземпляр SelectQuery
Обработчик операции drag-n-drop записи
MemoryDataset
Входящие параметры:
DataGrid - экземпляр компонента DataGrid, в
котором произошла операция drop;
SourceDataGrid - экземпляр компонента
DataGrid, в котором началась операция drag;
RowIDs - массив ID перемещаемых записей;
DestinationRowID - ID записи, в которой
EnableAllFilters
EnableColumn
EnableColumns
EnableColumnsByArray
EnableColumnsFilter
EnableControlByDataFieldName
EnableDatasetDataFields
EnableDatasetField
EnableDatasetFilters
произошел drop;
DropMode - режим операции drop (см. в
scr_SysEnums перечисление
_DataGridDropModeEnum)
Включить все фильтры по коллекции фильтров у
SelectQuery
Параметры:
FiltersNode - коллекция фильтров, которую
нужно включить/выключить;
Enabled - включить/выключить
Включить/выключить определенные колонки
Входящие параметры:
Columns - коллекция колонок SelectQuery;
ColumnAlias - массив имен колонок;
Enabled - включить/выключить колонки
Включить/выключить все колонки SelectQuery
Входящие параметры:
Columns - коллекция колонок SelectQuery;
Enabled - включить/выключить колонки
Включить/выключить колонки на основе
массива их алиасов
Входящие параметры:
Columns - коллекция колонок SelectQuery;
Enabled - "Включить/выключить";
FieldNamesArray - алиас колонки
Включить фильтр в SelectQuery по массиву
названий фильтров
Параметры:
SelectQuery - экземпляр SelectQuery;
FilterNames - массив кодов фильтров;
Enabled - включить/выключить
Включить элемент управления по имени
DataField-а
Входящие параметры:
Window - экземпляр окна;
DataFieldName - имя DataField-а;
Enabled - включить/выключить контрол
Включить/выключить поля датасета
Входящие параметры:
Dataset - экземпляр датасета;
IsEnabled - включить/выключить;
DoProcessColumns - включать/выключать ли
колонки и в SelectQuery
Включить/выключить поле датасета
Входящие параметры:
Dataset - экземпляр датасета;
DataField - поле датасета;
Enabled - включить/выключить
Включить/выключить фильтры датасета (набора
данных)
Входящие параметры:
Dataset - экземпляр датасета;
Enabled - включить/выключить фильтры;
EnableDeleteQueryFilters
EnableFilter
EnableFilters
EnableQueryColumns
EnableSelectQueryColumns
EnableSelectQueryFilters
EnableUpdateQueryFilters
FieldSQLDataTypeToParamDataType
FilterLookupDatasetByDatasetField
FilterCodes - массив названий фильтров (если
этот параметр не передавать, то функция будет
работать по всем фильтрам)
Включить/выключить массив фильтров
DeleteQuery
Параметры:
DeleteQuery - экземпляр DeleteQuery;
Enabled - включить/выключить;
FilterCodesArray - массив кодов фильтров
Включить фильтр по его коду
Параметры:
FiltersNode - коллекция фильтров у SelectQuery;
FilterCode - код фильтра;
Enabled - включить/выключить
Включить определенные фильтры
Параметры:
Filters - коллекция фильтров;
Enabled - включить/выключить;
FilterCodesArray - массив кодов фильтров
Включить/выключить все колонки SelectQuery
Входящие параметры:
Columns - коллекция колонок;
IsEnabled - "Включить/выключить"
Включить/выключить определенные колонки
SelectQuery
Входящие параметры:
SelectQuery - экземпляр SelectQuery;
IsEnabled - включить/выключить колонки;
ColumnArray - массив имен колонок
Включить/выключить фильтры SelectQuery
Параметры:
SelectQuery - экземпляр SelectQuery;
Enabled - включить/выключить;
FilterCodesArray - массив кодов фильтров
Включить/выключить массив фильтров
UpdateQuery
Параметры:
UpdateQuery - экземпляр UpdateQuery;
Enabled - включить/выключить;
FilterCodesArray - массив кодов фильтров
Получить тип параметра по типу поля таблицы
Входящие параметры:
SQLType - тип поля таблицы
Применение фильтра к датасету полясправочника по значению самого поля
Входящие параметры:
Dataset - экземпляр датасета-источника;
FilteredFieldName - имя поля-справочника, к
датасету которого нужно применить фильтр;
FilteringFieldName - имя поля-справочника,
значение которого нужно применять в фильтре;
FilteringFieldInLookupName - имя поля/фильтра;
EnableOnEmpty - применять ли фильтр, если
ForceCopySubTree
GenParamName
GetCachedDictionary
GetCachedDictionaryRecord
GetCachedDictionaryRecordValue
GetColumnByDataField
GetColumnTableAlias
GetControlByDataFieldName
GetDataFieldByFieldName
GetDataFieldBySQLName
GetDataFieldNameByTableFieldName
значение фильтра пусто
Копирование ветки датасета-иерархии ("ветки
дерева") с отключением событий
Входящие параметры:
Dataset - датасет-источник;
ParentFieldName - имя родительского поля, в
котором хранится ссылка на родительскую
запись;
SourceParentID - ID копируемой записи;
DestinationParentID - ID записи, в которую
копируются данные вместе с вложениями
Генерация имени параметра
Входящий параметр: Params - коллекция
параметров SelectQuery
Получить закешированный справочник полей
датасета и их значений
Входящие параметры:
DatasetUSI - USI датасета;
KeyFieldName - ключ в кеше
Получить запись запись из закешированного
справочника по ID записи
Входящие параметры:
DatasetUSI - USI датасета;
ID - ID записи
Получить значение конкретного поля датасета
из закешированного справочника по ID записи
Входящие параметры:
DatasetUSI - USI датасета;
ID - ID записи;
FieldName - имя поля
Получить колонку SelectQuery по полю набора
данных
Входящие параметры:
DataField - поле датасета
Получить алиас таблицы у колонки
Входящие параметры:
Column - экземпляр колонки
Получить элемент управления по имени
связанного с ним DataField-а
Входящие параметры:
Window - экземпляр окна;
DataFieldName - имя DataField-а
Получить поле датасета по его имени
Входящие параметры:
Dataset - экземпляр Dataset;
FieldName - имя поля
Получить поле датасета по имени поля таблицы
Входящие параметры:
DBDataset - набор данных;
CheckSQLName - имя поля таблицы
Получить алиас поля в SelectQuery
Входящие параметры:
TableFieldName - имя таблицы;
GetDatasetByTable
GetDatasetDisplayValue
GetDatasetFieldValue
GetDatasetFieldValueByID
GetDatasetFieldValueFromDatasetByFilter
GetDatasetFieldValueFromDatasetByUSI
GetDatasetFieldValuesByID
GetDatasetFieldsValuesNamedArray
GetDatasetFirstRecordValue
Dataset - экземпляр Dataset;
CheckJoin - нужно ли искать поле в джойнах
Создать датасет на основании таблицы
Входящие параметры:
Table - экземпляр таблицы
Получить отображаемое значение полясправочника
Входящие параметры:
DatasetUSI - имя датасета-справочника;
RecordID - ключевое значение, по которому
ищется значение в справочнике
Получить значение поля датасета (с проверко
на наличие записей в датасете)
Входящие параметры:
Dataset - экземпляр Dataset;
FieldName - имя поля
Получить значение поля датасета по ID записи
Входящие параметры:
DatasetUSI - USI датасета;
IDValue - ID записи;
FieldName - имя поля, значение которого
получаем
Получение значения указанного поля датасета
при фильтрации по другому полю (третий
вариант)
Входящие параметры:
Dataset - USI датасета;
FilterFieldName - имя фильтра;
FilterFieldValue - значение фильтра;
ResultFieldName - поле датасета, значение
которого хотим получить
Получение значения указанного поля датасета
при фильтрации по другому полю
Входящие параметры:
DatasetUSI - USI датасета;
FilterFieldName - имя фильтра;
FilterFieldValue - значение фильтра;
ResultFieldName - поле датасета, значение
которого хотим получить
Получение справочника значений полей
датасета по ID записи
Входящие параметры:
DatasetUSI - USI датасета;
ID - ID записи;
FieldNames - массив имен полей
Получение именованного массива значений
датасета
Входящие параметры:
Dataset - экземпляр датасета;
FieldNames - массив имен полей, значения
которых нужно получить
Получение первой записи датасета
Входящие параметры:
GetDatasetFromWindow
GetDatasetIDByFieldValue
GetDatasetIDField
GetDatasetRecordID
GetDatasetTableName
GetDictionaryIDByName
GetDisplayFieldNamesFromDataset
GetEnableFilter
GetEnumDisplayValue
GetExistEnableFilter
GetExistEnableSelectQueryFilters
DatasetUSI - USI датасета;
FieldName - имя поля, значение которого нужно
получить
Получить набор данных окна по имени
DatasetLink-а
Входящие параметры:
Window - экземпляр окна;
DatasetLinkName - имя DatasetLink-а в окне
Получить значение первичного ключа в
датасете по значению другого поля
Входящие параметры:
DatasetUSI - USI датасета;
FieldName - имя поля, по которому будет
проводиться поиск;
FieldValue - значение, по которому ищем
Получить поле ID в датасете
Входящие параметры:
Dataset - экземпляр Dataset
Получить значение поля ID записи датасета
Входящие параметры:
Dataset - экземпляр Dataset
Получить имя таблицы по датасету
Входящие параметры:
Dataset - экземпляр датасета
Получить значение первичного ключа в
датасете по полю "Название"
Входящие параметры:
DatasetUSI - USI датасета;
Name - значение поля "Название", по которому
ищем
Получить массив полей датасета, которые могут
быть отображены в гриде
Входящие параметры:
Dataset - экземпляр датасета;
ExcludeItems - массив имен полей, которые не
должны быть включены в результирующий
массив
Получение экземпляра фильтра по его коду
Входящие параметры:
FiltersNode - коллекция фильтров;
FilterCode - имя искомого фильтра
Получить отображаемое значение поляперечисления
Входящие параметры:
EnumUSI - имя датасета-перечисления;
EnumItemID - ключевое значение, по которому
ищется значение в перечислении
Функция определяет включен ли хоть какойнибудь фильтр внутри передаваемой в нее
коллекции фильтров
Параметры:
FiltersNode - коллекция фильтров
Функция определяет включен ли хоть какой-
GetFieldValueFromDatasetUSIByFilterFieldValue
GetFieldValueFromDisabledField
GetFieldValueFromDisabledFieldByField
GetFieldValueFromLookupDataset
GetFieldValueFromLookupDatasetByLookupField
GetFieldValuesArray
GetFieldsAreEmpty
GetFieldsValuesAreChanged
нибудь фильтр у SelectQuery
Параметры:
FiltersNode - коллекция фильтров
Получение значения указанного поля датасета
при фильтрации по другому полю (второй
вариант)
Входящие параметры:
DatasetUSI - USI датасета;
FilterFieldName - имя фильтра;
FilterFieldValue - значение фильтра;
ResultFieldName - поле датасета, значение
которого хотим получить
Получить значение поля датасета по его имени
(даже если оно отключалось в SelectQuery)
Входящие параметры:
Dataset - экземпляр датасета;
DataFieldName - имя поля
Получить значение по полю датасета (даже
если оно отключалось в SelectQuery)
Входящие параметры:
DataField - экземпляр поля датасета
Получение значения любого поля из
справочника-источника лукапного поля
Входящие параметры:
Dataset - экземпляр датасета;
IDValue - значение поля-справочника;
ResultFieldName - название поля, значение
которое нам нужно получить
Получение значения любого поля из
справочника-источника лукапного поля (второй
вариант)
Входящие параметры:
DataField - поле-справочник;
ResultFieldName - название поля, значение
которое нам нужно получить
Получить массив из записей определенного
поля по всему датасету
Входящие параметры:
Dataset - экземпляр датасета;
FieldName - имя поля
Проверка, все ли поля в датасете пусты
Входящие параметры:
Dataset - экземпляр датасета;
FieldNames - массив имен полей, по которым
идет проверка
Изменялись ли значения в датасете. Если хоть
одно значение из списка
передаваемых параметров менялось,
возвращается true.
Входящие параметры:
Dataset - экземпляр датасета;
DataFieldNames - не используется. Нужно
передавать список полей через запятую
GetGeneralColumn
GetGeneralColumnByDataField
GetGeneralColumnTableField
GetIDsArray
GetIsRecordIDAccessAllowByDatasetInScr_DB
GetIsRecordIDCanDeleteByDataset
GetKeyDataField
GetLookupDatasetCopy
GetParameterTypeBySQLDataType
GetParameterValue
GetPrimaryDisplayDataFieldValueString
GetRealTableSQLName
Получить основную колонку SelectQuery по
алиасу
Входящие параметры:
Columns - коллекция колонок SelectQuery;
ColumnAlias - алиас колонки
Получить основную колонку SelectQuery по
полю набора данных
Входящие параметры:
DataField - поле датасета
Получить поле таблицы по алиасу колонки
SelectQuery
Входящие параметры:
Columns - коллекция колонок SelectQuery;
ColumnAlias - алиас колонки
Получить массив из ID записей по всему
датасету
Входящие параметры:
Dataset - экземпляр датасета
Можно ли выполнить операцию (вставка,
изменение, удаление) с записью
Входящие параметры:
Dataset - экземпляр датасета;
RecordID - ID записи;
AccessLevelFieldName - название операции
(CanInsert, CanUpdate, CanDelete)
Можно ли удалить запись датасета
Входящие параметры:
Dataset - экземпляр датасета;
RecordID - ID записи
Получить ключевое поле датасета
Входящие параметры:
Dataset - экземпляр датасета
Получение копии поля-справочника
Входящие параметры:
Dataset - экземпляр датасета;
LookupFieldName - имя поля-справочника
Получить тип параметра по типу поля таблицы
Входящие параметры:
SQLDataType - тип поля таблицы
Получение параметра по его имени
Параметры:
Parameters - коллекция параметров у
SelectQuery;
ParamName - имя параметра
Получить значение первичного поля для
отображения датасета
Входящие параметры:
Dataset - экземпляр датасета;
DisplayDataFieldName - имя первичного поля
для отображения
Получить имя таблицы с учетом,
администрируется ли она или нет
Входящие параметры:
GetSelectQueryFilterByCode
GetSelectQueryPrimarySelect
GetSelectQueryWithEnabledColumns
GetSortedMemoryDataset
GetStatusIDByFlags
GetTableFieldByDataField
GetTableFieldBySQLName
GetTableFromKeyDataField
IsDataControl
IsDatasetEmpty
IsGeneralColumn
IsSystemField
LoadDatasetFromProfile
Table - экземпляр таблицы
Получение экземпляра фильтра в SelectQuery
по его коду
Входящие параметры:
SelectQuery - экземпляр SelectQuery;
FilterCode - имя искомого фильтра
Получение первого Select-а по SelectQuery
Получить SelectQuery только с конкретным
набором колонок
Входящие параметры:
SelectQueryCode - код SelectQuery;
UniqueCode - код для кеширования SelectQuery;
ColumnAliasesArray - массив алиасов
включаемых колонок
Получить отсортированный массив
MemoryDataset на основании датасета
Входящие параметры:
Dataset - экземпляр датасета;
OrderByFieldName - поле сортировки;
OrderType - тип сортировки (см. в scr_SysEnums
перечисление _OrderTypeEnum)
Получение значения из справочника статусов по
флагам "начальное состояние"/"конечное
состояние"
Входящие параметры:
StatusDatasetUSI - USI датасета статусов;
IsStart - нужно ли фильтровать по полю
"Начальное состояние";
IsFinish - нужно ли фильтровать по полю
"Конечное состояние"
Получить поле таблицы по полю набора данных
Входящие параметры:
DataField - поле датасета;
SelectQueryColumns - коллекция колонок
SelectQuery
Получить поле таблицы по его имени из
датасета
Входящие параметры:
DBDataset - набор данных;
CheckSQLName - имя поля таблицы
Получить таблицу по ее полю-первичному
ключу
Входящие параметры:
KeyDataField - поле-первичный ключ
Является ли элемент управления DataControl-ом
Проверка "пустой ли набор данных"
Является ли колонка основной (обычной)
Входящие параметры:
Column - колонка SelectQuery
Служебное ли поле
Параметры:
FieldSQLName - имя поля
Загрузить датасет из профиля пользователя
LoadRecord
MoveMemoryDatasetRowData
OpenDatasetWithDisabledEvents
PrepareDataset
RefreshDataset
RefreshDatasetAndRestorePosition
RefreshDetailData
RefreshDetailDataByParentID
RenameFilterCode
Входящие параметры:
Dataset - экземпляр датасета
Key - ключ в профиле
Загрузить значения полей в переменную типа
Object
Входящие параметры:
Dataset - экземпляр датасета;
Obj - переменная типа Object
Перемещение одной записи из одного
MemoryDataset-а в другой
Входящие параметры:
SourceDataset - датасет-источник;
DestinationDataset - датасет-получатель
Открывать датасет с отключением на нем
событий
Входящие параметры:
Dataset - экземпляр датасета
Подготовить датасет (закрыть, очистить от
фильтров, применить фильтр по ID)
Входящие параметры:
Dataset - экземпляр датасета;
DatasetUSI - USI датасета (применяется, если в
первом параметре не передан датасет);
ID - ID записи;
NotEraseFilters - флаг "не отключать фильтры"
Переоткрыть(обновить) набор данных
Входящие параметры:
Dataset - экземпляр датасета
Переоткрыть набор данных и вернуться в
исходную позицию датасета
Входящие параметры:
Dataset - экземпляр датасета
Обновить данные в детали
Входящие параметры:
ParentDataset - родительский набор данных
ParentFieldName - название ключевого поля
родительской набора данных (обычно это ID);
ChildDataset - дочерний датасет, который
обновляется;
ChildFilterName - имя фильтра, который
применяется для обновления записей
Обновить подчиненные данные по
родительской записи
Входящие параметры:
ParentID - ID родительской записи;
ChildDataset - датасет, который обновляется;
ChildFilterName - имя фильтра, который
применяется для обновления записей;
DoNotDisableAllFilters - флаг "не отключать все
фильтры перед обновлением"
Переименовать фильтр
Входящие параметры:
Filter - экземпляр фильтра;
ReplaceColumnSQLText
RollbackTransaction
SQLDataTypeToDataFieldType
SaveDatasetToProfile
SetCurrentDateDatasetField
SetDataFieldRoundFloatValue
SetDatasetDataFieldsIsEnabledState
SetDatasetFieldGUIDValue
SetDatasetFieldValues
SetDatasetIDByName
SourceCode - имя фильтра, которое нужно
заменить;
DestinationCode - имя фильтра, на которое
нужно заменить
Сделать замены в тексте колонок с SQL-текстом
Входящие параметры:
SelectQuery - экземпляр SelectQuery;
ObjectRegExp - объект RegExp (с RegExp
выражением) для поиска подстрок, которые
нужно заменить;
ObjectSQLName - на что необходимо заменить
Отмена транзакции
Получить тип поля таблицы по типу поля
датасета
Входящие параметры:
SQLDataType - тип поля таблицы
Сохранить датасет в профиль пользователя
Входящие параметры:
Dataset - экземпляр датасета
Key - ключ в профиле
Установка текущей даты поле датасета
Входящие параметры:
Dataset - экземпляр датасета;
DateFieldName - поле датасета типа
"Дата/Время"
Установка дробного значения с округлением
Входящие параметры:
DataField - поле датасета;
Value - дробное значение
Включить поля датасета по массиву их имен
Входящие параметры:
Dataset - экземпляр датасета;
DataFieldNamesArray - массив имен полей;
State - "Включить/выключить";
DoDisableAll - флаг "Отключить все поля" (до
включения нужных полей)
Установить значение поля-справочника
Входящие параметры:
Window - экземпляр окна;
DatasetLinkName - имя DatasetLink-а в окне
Установка массива значений в датасете
Входящие параметры:
DatasetUSI - USI датасета;
ID - ID записи;
FieldNames - массив имен изменяемых полей;
FieldValues - массив значений;
DoNotDisableEvents - не отключать события
датасета при внесении изменений
Поиск в справочнике по названию и установка
результата в поле-справочник
Входящие параметры:
SourceDataset - экземпляр датасета, в котором
нужно изменить поле-справочник;
SetDefaultLookupFieldValue
SetDefaultValuesByDataset
SetFieldValueWithCheck
SetFloatDataFieldWithRound
SetParameterValue
SetSelectQueryColumnsIsEnabledState
StartTransaction
UpdateRecordField
ValAsFloat
FieldName - имя поля, которое нужно
заполнить;
DatasetUSI - USI датасета-справочника;
Name - значение, которое ищем
Установка значения в поле-справочник,
полученного фильтрацией по значению
Входящие параметры:
LookupField - поле-справочник, в которое
пишется найденного значение;
FilterFieldName - имя фильтра;
FilterFieldValue - значение, по которому
фильтруем
Заполнить справочник значениями из датасета
Входящие параметры:
Dictionary - экземпляр справочника;
Dataset - экземпляр датасета
Установка значения поля с проверкой, равно ли
новое значение старому
Входящие параметры:
DataFieldName - имя поля;
Value - присваиваемое значение;
Dataset - экземпляр датасета
//outdated
Установить значение параметра по его имени
Параметры:
Parameters - коллекция параметров у
SelectQuery;
ParamName - имя параметра;
ParamValue - значение параметра
Включить колонки SelectQuery по массиву их
алиасов
Входящие параметры:
SelectQuery - экземпляр SelectQuery;
ColumnNamesArray - массив алиасов колонок;
State - Включить/Выключить;
SetCanDisable - флаг "Всегда выбирать в
запросе"
Начало транзакции на SQL-сервере
Редактировать значение через UpdateQuery
Входящие параметры:
UpdateQuery - экземпляр UpdateQuery;
ID - идентификатор записи;
UpdateFields - массив названий редактируемых
полей;
FieldValues - массив значений;
RefreshDataset - датасет для обновления после
редактирования(необязательный параметр)
Получение дробного значения из поля датасета
(с обработкой ситуации Not-a-Number)
Входящие параметры:
DataField - поле датасета
Download