Difference between revisions of "Tab.AddColumn"

From SunFlurry wiki
Jump to: navigation, search
1>Admin
(Примеры)
m (1 revision imported)
 
(No difference)

Latest revision as of 11:33, 25 April 2023

  AddColumn (Работа со столбцами)
Объект:Таблица
Статус разработки: Реализована
Тип:Функция
Обращение к БД:Нет
Исключения:Невозможно превратить в число, строку
Визуальность:Нет

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

Синтаксис

Tab.AddColumn(<Наименование столбца (STRING)>,<Заголовок столбца (STRING)>,<Тип данных столбца (STRING)>,<Ширина столбца (INT)>,<Режим выравнивания столбца (INT)>,<Видимость столбца (INT)>)

Аргументы

  • <Наименование столбца (STRING)> - (необязательный аргумент) Строковое значение, задающее наименование столбца. Таблица может иметь более одного столбца с одним и тем же наименованием. Наименования всегда хранятся в верхнем регистре (при добавлении или поиске столбцов по наименованиям, они сначала переводятся в верхний регистр).
  • <Заголовок столбца (STRING)> - (необязательный аргумент) Строковое значение, задающее заголовок столбца. Заголовок виден на экране только для визуальных таблиц.
  • <Тип данных столбца (STRING)> - (необязательный аргумент) Строковое значение, задающее тип данных столбца, если тип данных не задан, данные в столбце могут принимать любой тип, иначе, если значение, помещаемое в данный столбец таблицы не будет удовлетворять указанному типу данных, оно будет преобразовано в этот тип, если преобразование невозможно (типы несовместимы), будет использовано пустое значение, соответствующее заданному типу данных. Тип данных может быть составным (состоять из нескольких простых типов). Формат типа данных имеет следующий вид: <Тип данных 1>[,<Тип данных 2>[,..<Тип данных N>]], при этом каждый тип имеет вид: <Простой тип>[.<Простой подтип>[.<Дополнительные параметры>]]. Подтип и параметры определены только для некоторых типов, поддерживаемых функцией. Ниже дан список допустимых типов:
  • NUMBER, NUM: тип данных вещественных или целых чисел. Тип имеет формат NUMBER[.<Цифр в целой части>[.<Цифр в дробной части>[.<Признак только положительных чисел>]]]. Если параметр <Цифр в дробной части> больше нуля, тип данных будет задавать только вещественные числа. <Признак только положительных чисел> может отсутствовать или принимать значение +. Пример: NUM.15.2.+.
  • INTEGER, INT: тип данных целых чисел.
  • REAL: тип данных произвольных вещественных чисел (без ограничения по количеству цифр в дробной части).
  • DATE: тип данных даты и времени. Тип имеет формат DATE[.<Формат даты>[.<Формат времени>]]. Параметры типа задают способ вывода дат на экран в столбиках визуальной таблицы, они не влияют на данные, которые присваиваются ячейкам таблиц. <Формат даты> число в диапазоне 1..3, для 1: (по умолчанию) выводится короткая дата в формате ДД.ММ.ГГ, для 2: выводится длинная дата в формате ДД.ММ.ГГГГ, для 3: дата не выводится. <Формат времени> число в диапазоне 1..3, для 1: выводится короткое время в формате ЧЧ:ММ, для 2: выводится полное время в формате ЧЧ:ММ:СС, для 3: (по умолчанию) время не выводится. Пример: DATE.2.2.
  • STRING, STR: тип данных строк (как ANSI так и UTF-16). Тип имеет формат STRING[.<Максимальная длина строки>]. <Максимальная длина строки> по умолчанию равна нулю (строка не имеет ограничений по длине).
  • ANY: обозначает любой тип данных объекта базы данных.
  • REFERENCE, REF: тип данных справочников объектов базы данных. Тип имеет формат REF[.<Вид справочника>].
  • DOCUMENT, DOC: тип данных документов объектов базы данных. Тип имеет формат DOC[.<Вид документа>].
  • DBVAR, VAR: тип данных переменной объектов базы данных. Тип имеет формат DBVAR[.<Вид переменной>].
  • ENUMERATION, ENUM: тип данных перечисления объектов базы данных. Тип имеет формат ENUM[.<Вид перечисления>].
  • STORAGE, STOR: тип данных накопителя объектов базы данных. Тип имеет формат STOR[.<Вид накопителя>] (подобный тип данных не имеет особого смысла)
  • JOURNAL, JOUR, JOR: тип данных журнала (документов или справочников) объектов базы данных. Тип имеет формат JOR[.<Вид журнала>]
  • NOTHING: тип данных пустого значения (подобный тип данных не имеет особого смысла)

К примеру, можно задать тип, определяющий несколько видов справочников: REF.Номенклатура,REF.Контрагенты

  • <Ширина столбца (INT)> - (необязательный аргумент) Числовое значение, задающее текущую ширину столбца в точках на экране для экранных таблиц. Если ширина столбца равна нулю, при первом выводе таблицы на экран, система автоматически подбирает ширину с учетом типа данных столбца (что может давать не совсем желаемый результат).
  • <Режим выравнивания столбца (INT)> - (необязательный аргумент) Числовое значение, задающее способ выравнивания информации в ячейках столбца при выводе на экран, имеет диапазон 0..2, где 0: (по умолчанию) выравнивание по левому краю, 1: выравнивание по правому краю, 2: выравнивание по центру.
  • <Видимость столбца (INT)> - (необязательный аргумент) Числовое значение, задающее видимость столбца на экране для визуальных таблиц (0 -- столбец не будет отображен, 1 -- столбец будет отображен).

Примеры

//Создается и заполняется таблица значений
aTab:=Tab.Create("b1,b2,b3");
aTab.AddColumn("b4",,"STRING");

aTab.AddLine("b1,b2,b3,b4",1,2,3,4);
aTab.AddLine("b1,b2,b3,b4",2,2,3,4);
aTab.AddLine("b1,b2,b3,b4",3,5,5,4);
aTab.AddLine("b1,b2,b3,b4",4,2,3,4);
aTab.AddLine("b1,b2,b3,b4",4,2,3,4);
aTab.AddLine("b1,b2,b3,b4",5,2,3,4);

Message(TypeStr(aTab.Get(1,"b4"))+":"+aTab.Get(1,"b4"));
//Выводит STRING:4, т.е. при присваивании чисел ячейкам столбца, они автоматически были преобразованы в строки.