Работа с Табличным Полем

Содержание

Эта часть документации описывает работу с ЭУ "ТабличноеПоле".

Табличное поле

Элемент управления, представляющий данные в виде таблицы. Работает со специальными объектами - источниками данных, называемыми поставщиками данных табличного поля. Поставщики данных обеспечивают специальный интерфейс, через который табличное поле получает данные. Само табличное поле не работает с источниками данных (базой данных, файлом, таблицами в памяти и т.п.), оно пользуется только тем, что предоставляет ему поставщик данных.

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

Подержка полиморфного поведения при обработке событий

События табличного поля может обрабатывать КОП-наследник от ТабличногоПоля. Процедуры-обработчики событий должны быть объявлены с ключевым словом Экспорт (protected или public) и должны иметь имя, совпадающее с именем обрабатываемого события.

События могут быть заданы в КОПе и в модуле формы одновременно, в этом случае сначала происходит вызов события в КОПе, затем в модуле формы.

ТабличноеПоле

Во всех объектах табличного поля и в нем самом, свойства, определяющие цвет различных элементов задаются стандартным числом RGB. Кроме того, свойства могут принимать специальное значение цвета, равное -1. Это означает авто-цвет - значение цвета будет определяться из настроек операционной системы.

Создание табличного поля.

Для создания объекта нужно разместить на форме кнопку - она будет реквизитом формы. После того, как окно формы создано (например в процедуре ПослеОткрытия()), необходимо получить объект АтрибутФормы, соответствующий этой кнопке и вызвать его метод АтрибутФормы::СоздатьЭлементУправления()|_1cpp_Formex_CreateControl_, передав в него:

  • строку "ТабличноеПоле": в этом случае будет создан объект типа ТабличноеПоле;
  • объект типа ТабличноеПоле: для создания ЭУ будет использован переданный объект.
  • объект КОПа наследника от объекта ТабличноеПоле (причем не обязательно непосредственный наследник): для создания ЭУ будет использован объект базового класса.

Метод возвращает объект типа ТабличноеПоле или переданный параметром объект.

Свойства

Колонки / Columns

Доступ: только чтение.

Тип: КолонкиТабличногоПоля.

Описание: Содержит коллекцию колонок табличного поля.

ПоставщикДанных / DataProvider

Доступ: чтение и запись.

Тип: объект.

Описание: Поставщик данных табличного поля.

См. также: Поставщики данных табличного поля

ВертСкроллер / VScroller

Доступ: чтение и запись.

Тип: Число.

Описание: Наличие вертикальной полосы прокрутки.

  • 0 - Автоматически скрывать, если все строки помещаются в табличном поле;
  • 1 - Всегда присутствует;
  • 2 - Всегда отсутствует.

НачальноеПредставление / StartView

Доступ: чтение и запись.

Тип: Число.

Описание: Используется для определения начального заполнения табличного поля, когда в него установлен поставщик данных.

  • 0 - с начала;
  • 1 - с конца.

РежимВыделенияСтроки / RowSelectMode

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет стиль выделения текущей строки.

  • 0 - выделяется ячейка
  • 1 - выделяется вся строка
  • 2 - текущая ячейка и текущая строка выделяется по-разному (для строки используются ЦветТекстаВыделения2 и ЦветФонаВыделения2)

РежимВыделения / SelectMode

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет режим выделения строк табличного поля.

  • 0 - одиночный (разрешено выделение одной строки)
  • 1 - множественный (разрешено выделение нескольких строк)

ВертикальныеЛинии / VerticalLines

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет наличие вертикальных разделительных линий между ячейками. 0 - линии не отображаются, 1 - линии отображаются.

ГоризонтальныеЛинии / HorizontalLines

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет наличие горизонтальных разделительных линий между ячейками. 0 - линии не отображаются, 1 - линии отображаются.

СтильЗаголовков / HeadersStyle

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет стиль отрисовки заголовков колонок.

  • 0 - стиль 3D;
  • 1 - плоский стиль.

СтильАктивногоЗаголовка / ActiveHeaderStyle

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет стиль отрисовки заголовка активной колонки.

  • 0 - активная колонка не выделяется;
  • 1 - активная колонка выделяется в стиле, соответствующем значению свойства 'СтильЗаголовков'.

СтильРамки / BorderStyle

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет стиль отрисовки рамки табличного поля.

  • 0 - стиль 3D;
  • 1 - плоский стиль.

ТекущаяКолонка / CurrentColumn

Доступ: чтение и запись.

Тип: КолонкаТабличногоПоля.

Описание: Определяет текущую колонку табличного поля.

ТекущиеДанные / CurrentData

Доступ: только чтение.

Тип: ДанныеСтроки.

Описание: Коллекция значений полей данных источника данных табличного поля. Данные текущей строки.

ВыделенныеСтроки / SelectedRows

Доступ: только чтение

Тип: ВыделенныеСтроки

Описание: Коллекция выделенных строк табличного поля

Шрифт / Font

Доступ: чтение и запись.

Тип: Шрифт.

Описание: Шрифт по умолчанию для колонок, строк, заголовков и ячеек табличного поля.

Определяет также высоту строки табличного поля. Высота строки будет определяться по высоте строки текста этого шрифта. Значение Авто означает, что будет использоваться шрифт формы. По отношению ко всем остальным дочерним объектам табличного поля (колонка, строка, ячейка), этот шрифт будет шрифтом с самым низким приоритетом.

Примечание: значение Авто в свойствах типа Шрифт дочерних объектов означает, что будет выбран шрифт с меньшим приоритетом.

ТаймаутОбновления / RefreshTimeout

Доступ: чтение и запись.

Тип: Число.

Описание: Интервал времени (в секундах), через который выполняется автоматическое обновление данных табличного поля. 0 - не обновлять автоматически.

ТаймаутБыстрогоПоиска / QuickSearchTimeout

Доступ: чтение и запись.

Тип: Число.

Описание: Интервал времени (в миллисекундах), через который выполняется попытка найти строку по введенным данным. табличного поля. 0 - автоматически не пытаться.

ИзменятьПозициюКолонок / ChangePositionOfColumns

Доступ: чтение и запись.

Тип: Число.

Описание: Разрешает или запрещает изменение позиции колонок. 0 - запрещает, 1 - разрешает.

ЦветЛиний / LinesColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет разделительных линий между ячейками табличного поля.

ЦветЛинийНеактивныхСтрок / InactiveRowsLinesColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет разделительных линий между ячейками с положением "на следующей строке" или "в той же колонке" в неактивных строках.

ЦветТекста / TextColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет текста табличного поля по умолчанию.

ЦветФона / BackColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет фона табличного поля по умолчанию. Имеет влияние на цвет ячеек и на пространство окна, не занятое данными табличного поля.

ЦветТекстаВыделения / SelectionTextColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет текста выделенной ячейки.

ЦветФонаВыделения / SelectionBackColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет фона выделенной ячейки.

ЦветТекстаВыделения2 / SelectionTextColor2

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет текста выделенной строки когда РежимВыделенияСтроки == 2.

ЦветФонаВыделения2 / SelectionBackColor2

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет фона выделенной ячейки когда РежимВыделенияСтроки == 2.

ЦветФонаЧередованияСтрок / AlternationRowBackColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет альтернативный цвет фона строки таблицы в режиме чередования цветов фона строк.

ЧередованиеЦветовСтрок / UseAlternationRowColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет режим чередования цвета фона строки. 0 - не чередовать, 1- чередовать.

ЦветОтрицательных / NegativesColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет текста начинающегося на знак "-" (минус).

Имеет значение по умолчанию -1. При этом цвет отрицательных - красный (0,0,255)

ЦветТекстаЗаголовков / HeadersTextColor

Доступ: чтение и запись.

Тип: Число.

Описание: Цвет текста заголовков.

ЦветФонаЗаголовков / HeadersBackColor

Доступ: чтение и запись.

Тип: Число.

Описание: Цвет фона заголовков.

ЦветРамки / BorderColor

Доступ: чтение и запись.

Тип: Число.

Описание: Цвет рамки и линий заголовков для плоского стиля отрисовки.

ТекущаяСтрока / CurrentRow

Доступ: чтение и запись.

Тип: определяется поставщиком данных. Указывается в описании конкретного поставщика данных.

Описание: Определяет текущую строку табличного поля. Cвойство обслуживается установленным поставщиком данных. При записи в это свойство, произойдет активизация соответствующей строки табличного поля.

См. также: Поставщики данных табличного поля

РазрешитьНачалоПеретаскивания / EnableStartDrag

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет поведение ЭУ для режима Drag&Drop. 1 - разрешает ЭУ выступать источником в операциях перетаскивания, 0 - запрещает.

Когда начало перетаскивания разрешено, работают события НачалоПеретаскивания / DragStart и ОкончаниеПеретаскивания / DragEnd.

РазрешитьПеретаскивание / EnableDrag

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет поведение ЭУ для режима Drag&Drop. 1 - разрешает ЭУ выступать приемником в операциях перетаскивания, 0 - запрещает.

Когда перетаскивание разрешено, работают события ПроверкаПеретаскивания / DragCheck и Перетаскивание / Drag.

ОтображатьЗаголовки / ShowHeaders

Доступ:

Чтение и запись
Тип:
Число
  • 1: отобразить заголовки
  • 0: скрыть заголовки
Описание:

Управляет отображением заголовков колонок ТП

ФиксацияСлева / FixedLeft

Доступ:Чтение и запись
Тип:Число
Описание:Содержит количество зафиксированных слева колонок. Зафиксированные колонки остаются на месте при горизонтальной прокрутке табличного поля.

ФиксацияСправа / FixedRight

Доступ:Чтение и запись
Тип:Число
Описание:Содержит количество зафиксированных справа колонок. Зафиксированные колонки остаются на месте при горизонтальной прокрутке табличного поля.

ПрозрачностьФонаЯчеек / CellBackTransparency

Доступ: чтение и запись.

Тип: Число.

Описание: Значение прозрачности фона ячеек табличного поля.

Свойство может принмать значения от 0 до 255. При значении свойства равном 0 прозрачность ячеек отключается - ячейки не прозрачны. При значении свойства равном 255 прозрачность ячеек максимальная - фон ячеек не выводится.

ПрозрачностьФонаЯчеекВыделения / SelectionCellBackTransparency

Доступ: чтение и запись.

Тип: Число.

Описание: Значение прозрачности фона выделенных ячеек табличного поля.

Свойство может принмать значения от 0 до 255. При значении свойства равном 0 прозрачность ячеек отключается - ячейки не прозрачны. При значении свойства равном 255 прозрачность ячеек максимальная - фон ячеек не выводится.

ПрозрачностьФонаЯчеекВыделения2 / SelectionCellBackTransparency2

Доступ: чтение и запись.

Тип: Число.

Описание: Значение прозрачности фона ячейки выделенной строки не текущей колонки когда РежимВыделенияСтроки = 2.

Свойство может принмать значения от 0 до 255. При значении свойства равном 0 прозрачность ячеек отключается - ячейки не прозрачны. При значении свойства равном 255 прозрачность ячеек максимальная - фон ячеек не выводится.

ПрозрачностьФонаЯчеекЧередованияСтрок / AlternationRowCellBackTransparency

Доступ: чтение и запись.

Тип: Число. Описание: Значение альтернативной прозрачности фона ячейки строки таблицы в режиме чередования цветов фона строк.

Свойство может принмать значения от 0 до 255. При значении свойства равном 0 прозрачность ячеек отключается - ячейки не прозрачны. При значении свойства равном 255 прозрачность ячеек максимальная - фон ячеек не выводится.

Методы

ОбновитьСтроки / RefreshRows

Синтаксис: ОбновитьСтроки()

Описание: перечитать строки, отображаемые в данный момент в табличном поле. Табличное поле будет стараться сохранить текущую строку.

ПерерисоватьСтроки / RedrawRows

Синтаксис:ПерерисоватьСтроки()
Возвращает:нет
Описание:Обновить строки, отображаемые в данный момент в табличном поле, без обращения к провайдеру.

УстановитьОтступы / SetTextMargins

Синтаксис:

УстановитьОтступы(чЛево, чВерх, чПраво, чНиз)
Параметры:
  • чЛево, тип: Число
  • чВерх, тип: Число
  • чПраво, тип: Число
  • чНиз, тип: Число
Возвращает:

нет
Описание:
Устанавливает отступы текста в пределах ячейки в соответствии с переданными параметрами.
Отрицательные значения параметров игнорируются.

ПолучитьГраницыТекущейЯчейки / GetCurrentCellBounds

Синтаксис:

ПолучитьГраницыТекущейЯчейки(чЛево, чВерх, чПраво, чНиз, флПривязка = 0)
Параметры:
  • чЛево, тип: Число
  • чВерх, тип: Число
  • чПраво, тип: Число
  • чНиз, тип: Число
  • флПривязка, тип: Число
    • 0: экранные координаты
    • 1: клиентские координаты
Возвращает:
  • 0: границы получить невозможно
  • 1: границы успешно получены
Описание:

Возвращет координаты текущей ячейки ТП

АвтоШирина / AutoWidth

Синтаксис:AutoWidth()
Параметры:нет
Возвращает:нет
Описание:
Устанавливает минимальную достаточную ширину для всех колонок ТП по видимой части ТП
Действие равнозначно двойному щелчку левой кнопкой мыши на разделителе колонок в заголовке ТП при нажатой клавише SHIFT

УстановитьСистемныеКартинки / SetSysPictures

Синтаксис: УстановитьСистемныеКартинки(Картинки, Ширина)

Параметры:

  • Картинки - тип: Картинка. Картинка - из которой будут получены отдельные пиктограммы для отображения в ячейках.
  • Ширина - тип: Число. Необязателен, по умолчанию 0. Ширина отдельной пиктограммы для отображения. Если равна нулю, ширина определяется высотой переданной картинки.

Описание: Устанавливает набор системных картинок для отображения в ячейках табличного поля.

Картинками считаются части общей переданной первым параметром картинки, полученные по следующим правилам: от левого верхнего угла слева направо, ширина равна высоте. Выбирается только первый ряд. Прозрачным является цвет RGB(0x00, 0x80, 0x80). Картинки будут доступны по индексу (от нуля).

ДобавитьСистемныеКартинки / AddSysPictures

Синтаксис: ДобавитьСистемныеКартинки(Картинки)

Параметры:

  • Картинки - тип: Картинка. Картинка - из которой будут получены отдельные пиктограммы для отображения в ячейках.

Описание: Дополняет набор системных картинок для отображения в ячейках табличного поля.

Метод допустимо вызывать для дополнения коллекции картинок после установки методом УстановитьСистемныеКартинки. Ширина отдельных пиктограмм равна ширине указанной при вызове метода УстановитьСистемныеКартинки.

СброситьСистемныеКартинки / ResetSysPictures

Синтаксис: СброситьСистемныеКартинки()

Описание: Очищает набор системных картинок табличного поля.

УстановитьФоновуюКартинку / SetBackgroundPicture

Синтаксис: УстановитьФоновуюКартинку(Картинка, ГорВыравнивание, ВертВыравнивание, Повтор, ЦветПрозрачности)

Параметры:

  • Картинка - тип: Картинка. Картинка выводимая на фоне грида.
  • ГорВыравнивание - тип: Число. Горизонтальное выравнивание. 0-слева, 1-справа, 2-по центру. Исходное значение 2.
  • ВертВыравнивание - тип: Число. Вертикальное выравнивание. 0-сверху, 1-снизу, 2-по центру. Исходное значение 2.
  • Повтор - тип: Число. Признак повтора картинки при выводе (размножение). 0-не повторять, 1-повторять. Исходное значение 0.
  • ЦветПрозрачности - тип: Число. RGB значение цвета который при выводе будет считаться прозрачным. При значении (-1) - прозрачности нет. Исходное значение (-1).

Описание: Устанавливает картинку фона и параметры ее вывода.

Все параметры не обязательные.

Если какой-либо параметр не указан при вызове метода, то соответствующие картинка либо параметр вывода сохраняют прежнее значение (не меняются).

При выводе имеет значение режим рисования картинки установленный методом Картинка::РежимРисования(Режим): 1-растягивать на весь размер грида, 2-рисовать с оригинальными размерами, 3-рисовать, сохраняя оригинальное соотношение размеров.

Параметры ГорВыравнивание, ВертВыравнивание и Повтор - влияют на вывод только при режиме рисования 2.

Параметр ЦветПрозрачности не имеет значения для картинок-иконок типа .ico

СброситьФоновуюКартинку / ResetBackgroundPicture

Синтаксис: СброситьФоновуюКартинку()

Описание: Отключает вывод фоновой картинки и устаналивает параметры вывода в исходные значения.

УстановитьФоновыйТекст / SetBackgroundText

Синтаксис: УстановитьФоновыйТекст(Текст, Шрифт, Цвет, ГорВыравнивание, ВертВыравнивание, Перенос)

Параметры:

  • Текст - тип: Строка. Текст выводимый на фоне грида.
  • Шрифт - тип: Шрифт. Шрифт выводимого текста. Исходное значение - шрифт текста табличного поля.
  • Цвет - тип: Число. RGB значение цвета текста. При значении (-1) текст принимает установленный цвет текста табличного поля. Исходное значение (-1).
  • ГорВыравнивание - тип: Число. Горизонтальное выравнивание. 0-слева, 1-справа, 2-по центру. Исходное значение 2.
  • ВертВыравнивание - тип: Число. Вертикальное выравнивание. 0-сверху, 1-снизу, 2-по центру. Исходное значение 2.
  • Перенос - тип: Число. Признак автоматического переноса строк текста по словам. 0-не переносить, 1-переносить. Исходное значение 1.

Описание: Устанавливает текст фона и параметры его вывода.

Все параметры не обязательные.

Если какой-либо параметр не указан при вызове метода, то соответствующие текст либо параметр вывода сохраняют прежнее значение (не меняются).

СброситьФоновыйТекст / ResetBackgroundText

Синтаксис: СброситьФоновыйТекст()

Описание: Отключает вывод фонового текста и устаналивает параметры вывода в исходные значения.

События

ПриВыводеСтроки / RowOut

Синтаксис: ПриВыводеСтроки(ОформлениеСтроки, ДанныеСтроки, ТипРегиона)

Параметры:

  • ОформлениеСтроки - тип: ОформлениеСтроки. Объект для управления оформлением выводимой строки табличного поля.
  • ДанныеСтроки - тип: ДанныеСтроки. Данные (коллекция значений полей) выводимой строки табличного поля.
  • ТипРегиона - тип: ТипыРегионовТП

Описание: Возникает при выводе (отображении) строки табличного поля.

Выбор / Selection

Синтаксис: Выбор(Строка, Колонка, ТипРегиона, ТипОбластиЯчейки)

Параметры:

Описание: Возникает при двойном клике для регионов 1 - 4, или нажатии клавиши Enter для региона 3. При нажатии Enter ТипОбластиЯчейки не определен. При активизации события для заголовка значения параметра Строка не определено.

ПриАктивизацииСтроки / ActivateRow

Синтаксис: ПриАктивизацииСтроки()

Описание: Возникает, когда любая строка становится текущей.

ПриАктивизацииКолонки / ActivateColumn

Синтаксис: ПриАктивизацииКолонки()

Описание: Возникает, когда любая колонка становится текущей.

ПриАктивизацииЯчейки / ActivateCell

Синтаксис: ПриАктивизацииЯчейки()

Описание: Возникает, когда ячейка становится текущей. Порядок прохождения событий: ПриАктивизацииСтроки, ПриАктивизацииКолонки, ПриАктивизацииЯчейки.

ПриВыбореЗаголовка / HeaderSelection

Синтаксис: ПриВыбореЗаголовка(Колонка)

Параметры:

Описание: Возникает, когда пользователь выбирает мышью заголовок колонки.

ПриКонтекстномМеню / ContextMenu

Синтаксис: ПриКонтекстномМеню(ТипРегиона, Колонка, Строка)

Параметры:

  • ТипРегиона - тип: ТипыРегионовТП
  • Колонка - тип: КолонкаТабличногоПоля. Колонка табличного поля, на которой было вызвано контекстное меню.
  • Строка - тип: определяется поставищком данных. Значение, идентифицирующее строку ТП.

Описание: Возникает, когда необходимо отобразить контекстное меню.

ПриВыбореФлажка / ClickCheckBox

Синтаксис: ПриВыбореФлажка(Строка, Колонка, ТипРегиона, ФлагВыбора)

Параметры:

  • Строка - тип: определяется поставищком данных. Значение, идентифицирующее строку ТП.

  • Колонка - тип: КолонкаТабличногоПоля

  • ТипРегиона - тип: ТипыРегионовТП

  • ФлагВыбора - тип: число. Флаг выполнения события Выбор.

    • 0 - подавлять событие выбора при двойном клике
    • 1 - не подавлять событие выбора при двойном клике

    При вызове события имеет значение 0, т.е. событие Выбор при выборе флажка будет подавляться.

Описание: Возникает, когда пользователь производит выбор флажка.

ПриВыбореКартинки / ClickPicture

Синтаксис: ПриВыбореКартинки(Строка, Колонка, ИндексКартинки, ТипРегиона, ФлагВыбора)

Параметры:

  • Строка - тип: определяется поставищком данных. Значение, идентифицирующее строку ТП.

  • Колонка - тип: КолонкаТабличногоПоля

  • ИндексКартинки - тип: Число. Индекс картинки в ячейке.

  • ТипРегиона - тип: ТипыРегионовТП

  • ФлагВыбора - тип: число. Флаг выполнения события Выбор.

    • 0 - подавлять событие выбора при двойном клике
    • 1 - не подавлять событие выбора при двойном клике

    При вызове события имеет значение 1, т.е. событие Выбор при выборе картинки не будет подавляться.

Описание: Возникает, когда пользователь производит выбор картинки.

ПриВыбореСистемнойКартинки / ClickSysPicture

Синтаксис: ПриВыбореСистемнойКартинки(Строка, Колонка, ИндексКартинки, ТипРегиона, ФлагВыбора)

Параметры:

  • Строка - тип: определяется поставищком данных. Значение, идентифицирующее строку ТП.

  • Колонка - тип: КолонкаТабличногоПоля

  • ИндексКартинки - тип: Число. Индекс системной картинки в ячейке.

  • ТипРегиона - тип: ТипыРегионовТП

  • ФлагВыбора - тип: число. Флаг выполнения события Выбор.

    • 0 - подавлять событие выбора при двойном клике
    • 1 - не подавлять событие выбора при двойном клике

    При вызове события имеет значение 0, т.е. событие Выбор при выборе системной картинки будет подавляться.

Описание: Возникает, когда пользователь производит выбор системной картинки.

НачалоПеретаскивания / DragStart

Синтаксис: НачалоПеретаскивания(ДопустимыеДействия, Значение, Колонка, ТипРегиона, ТипЦели)

Параметры:

  • ДопустимыеДействия - тип: Число. (Выход) Список допустимых действий перетаскивания. Список задается как сумма следующих значений:

    • 1 - копирование (Copy)
    • 2 - перетаскивание (Move)
    • 4 - связывание (Link)

    Значение по-умолчанию 1. Если необходимо разрешить другие действия, нужно изменить значение этого параметра на выходе из обработчика события. Если передать 0, т.е. не определить ни одного действия, Перетаскивание не начнется.

  • Значение - тип: определяется поставщиком данных. (Вход) Значение, идентифицирующее строку табличного поля. (Выход) Значение, которое будет представлять перетаскиваемые данные.

  • Колонка - тип: КолонкаТабличногоПоля

  • ТипРегиона - тип: ТипыРегионовТП

  • ТипЦели - тип: Число. (Выход) Определяет логическую область отображения перетаскиваемых данных в ТП.

    • 0 - не задано
    • 1 - ячейка
    • 2 - строка
    • 3 - колонка

Это значение используется для определения области ТП, в которой не нужно формировать события проверки перетаскивания, в том случае когда ЭУ-приемником является то же ТП, что и источник.

Описание: Возникает в ЭУ источнике данных, когда пользователь начинает перетаскивание (Drag&Drop).

ОкончаниеПеретаскивания / DragEnd

Синтаксис: ОкончаниеПеретаскивания(Действие, Значение, Колонка, ТипРегиона)

Параметры:

Описание: Возникает в ЭУ источнике данных, когда завершается операция перетаскивания (Drag&Drop).

Обычная обработка: в случае операции 2 (перетаскивания или Move) нужно удалить перетаскиваемые данные. В параметре Действие ЭУ источник данных всегда получит одно из тех действий, которое он определил для себя в событии НачалоПеретаскивания / DragStart.

Порядок прохождения событий:

ПроверкаПеретаскивания / DragCheck

Синтаксис: ПроверкаПеретаскивания(Действие, Значение, СтрокаТП, КолонкаТП, ТипРегионаТП, ТипЦели)

Параметры:

  • Действие - тип: Число. (Выход) Действие которое произойдет при совершении перетаскивания. По-умолчанию 0. Допустимые действия:

    • 0 - нет действия
    • 1 - копирование (Copy)
    • 2 - перетаскивание (Move)
    • 4 - связывание (Link)

  • Значение - тип: Любой. Значение, представляющее перетаскиваемые данные. Это значение было задано в обработчике события НачалоПеретаскивания|НачалоПеретаскивания.

  • СтрокаТП - тип: Любой. Значение представляющее строку табличного поля, в которую идет перетаскивание (находится под курсором). Обеспечивается поставщиком данных.

  • КолонкаТП - тип: КолонкаТабличногоПоля. Колонка табличного поля, в которую идет перетаскивание (находится под курсором).
    • ТипРегионаТП - тип: ТипыРегионовТП. Тип региона, в который идет перетаскивание.

  • ТипЦели - тип: Число. (Выход) Определяет логическую область приемника перетаскиваемых данных, которая подсвечивается рамкой. Значение по-умолчанию: если ЭУ источник данных - табличное поле, то значение, заданное в обработчике события НачалоПеретаскивания|НачалоПеретаскивания; если источник данных - некий другой ЭУ, то значение равно 0.

    • 0 - не задано
    • 1 - ячейка
    • 2 - строка
    • 3 - колонка

Описание: Возникает в ЭУ назначения перетаскивания для определения действия, которое произойдет при совершении операции перетаскивания. (Drag&Drop)

Главное назначение события - проверить возможность совершения операции перетаскивания и определить Действие. Событие возникает всякий раз, когда изменяется строка или колонка ТП. Если строка или колонка не определяются под курсором мыши, то значения соответствующих параметров будут равны пустому значению.

Перетаскивание / Drag

Синтаксис: Перетаскивание(Действие, Значение, СтрокаТП, КолонкаТП, ТипРегионаТП)

Параметры:

  • Действие - тип: Число. Действие, которое нужно выполнить для совершения перетаскивания. Равно значению параметра Действие на выходе из события ПроверкаПеретаскивания / DragCheck. Допустимые действия:

    • 1 - копирование (Copy)
    • 2 - перетаскивание (Move)
    • 4 - связывание (Link)

  • Значение - тип: Любой. Значение, представляющее перетаскиваемые данные. Это значение было задано в обработчике события НачалоПеретаскивания|НачалоПеретаскивания.

  • СтрокаТП - тип: Любой. Значение представляющее строку табличного поля, в которую идет перетаскивание (находится под курсором). Обеспечивается поставщиком данных.

  • КолонкаТП - тип: КолонкаТабличногоПоля. Колонка табличного поля, в которую идет перетаскивание (находится под курсором).
    • ТипРегионаТП - тип: ТипыРегионовТП. Тип региона, в который идет перетаскивание.

Описание: Возникает в ЭУ назначения, когда совершается операция перетаскивания (Drag&Drop).

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

ПриУничтожении / OnDestroy

Синтаксис: ПриУничтожении()

Параметры: нет

Описание: Событие вызывается при уничтожении контрола, с которым связано ТП, до уничтожения самого ТП.

ПриНачалеБыстрогоПоиска / OnQuickSearchStart

Синтаксис: ПриНачалеБыстрогоПоиска(чТипБыстрогоПоиска, чФСО)

Параметры:
  • чТипБыстрогоПоиска, тип: Число
    Тип быстрого поиска:
    • 1 - текстовый быстрый поиск
  • чФСО, тип: Число

    Доступ: чтение и запись

    Флаг стандартной обработки. Возможные значения для установки:
    • 1 - быстрый поиск разрешен
    • 0 - быстрый поиск запрещен

    Значение по умолчанию: 1

Описание: Событие вызывается до инициализации окна быстрого поиска и позволяет управлять разрешением на его создание.

ПриБыстромПоиске / OnQuickSearch

Синтаксис:
ПриБыстромПоиске(чТипБыстрогоПоиска, нДанные, чФСО)
Параметры:
  • чТипБыстрогоПоиска, тип: Число
    Тип быстрого поиска:
    • 1 - текстовый быстрый поиск
  • нДанные, тип: для текстового быстрого поиска - Строка

    Доступ: чтение и запись

    Данные, введенные в окне быстрого поиска

  • чФСО, тип: Число
    Флаг стандартной обработки. Возможные значения для установки:
    • 1 - быстрый поиск разрешен
    • 0 - быстрый поиск запрещен

    Значение по умолчанию: 1

Описание: Событие вызывается до выполнения системной процедуры быстрого поиска и позволяет организовать специальные алгоритмы поиска.

Возможна трансформация данных с последующей системной обработкой, а также полная замена системной обработки на собственную.

ПриОкончанииБыстрогоПоиска / OnQuickSearchEnd

Синтаксис:
ПриОкончанииБыстрогоПоиска(флРезультат, флПерепозиционировано)
Параметры:
  • флРезультат, тип: Число
    Причина закрытия окна быстрого поиска.
    • 1 - закрытие клавишей ENTER
    • 0 - отмена быстрого поиска (любым способом)
  • флПерепозиционировано, тип: Число
    Флаг, отражающий факт перепозиционирования непосредственно перед закрытием окна БП
    • 1 - ТП было перепозиционировано
    • 0 - ТП не было перепозиционировано

Описание: Событие вызывается после закрытия окна быстрого поиска.

ПриПеремещенииКолонки / OnColumnMove

Синтаксис:
ПриПеремещенииКолонки(Колонка, чСдвиг, чФСО)
Параметры:

  • Колонка, тип: КолонкаТабличногоПоля

  • чСдвиг, тип: Число

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

  • чФСО, тип: Число
    Флаг стандартной обработки. Возможные значения для установки:
    • 1 - перемещение колонки разрешено
    • 0 - перемещение колонки запрещено

    Значение по умолчанию: 1

Описание: Событие вызывается при интерактивном перемещении колонки ТП непосредственно перед выполнением перемещения.

ПриИзмененииВидимостиКолонки / OnColumnVisibilityChange

Синтаксис:
ПриИзмененииВидимостиКолонки(Колонка, флВидимость, чФСО)
Параметры:

  • Колонка, тип: КолонкаТабличногоПоля

  • флВидимость, тип: Число

    Предлагаемое значение флага видимости колонки

  • чФСО, тип: Число
    Флаг стандартной обработки. Возможные значения для установки:
    • 1 - изменение видимости колонки разрешено
    • 0 - изменение видимости колонки запрещено

    Значение по умолчанию: 1

Описание: Событие вызывается при интерактивном изменении видимости колонки ТП непосредственно перед выполнением изменения видимости.

ПриИзмененииШириныКолонки / OnColumnWidthChange

Синтаксис:
ПриИзмененииШириныКолонки()
Параметры:
нет

Описание: Событие вызывается при интерактивном изменении ширины одной или нескольких колонок.

ПриНажатииКлавиши / OnKeyDown

Синтаксис ПриНажатииКлавиши(ВиртКод, Данные, Клавиатура, ФСО)

Параметры

  • ВиртКод - тип: Число. Код виртуальной клавиши не системной.

  • Данные - тип: Число. Определяет счетчик повторения, скан-код и прочее. Подробнее см. MSDN: http://msdn.microsoft.com/en-us/library/ms646280(VS.85).aspx

  • Клавиатура - тип: Клавиатура. Ссылка на сервисный объект работы с состоянием клавиатуры.

  • ФСО - флаг стандартной обработки. При вызове равен 1. Установка в 0 отменяет штатную обработку.

    Внимание: важно помнить, что передача 0 может остановить важную системную обработку нажатия клавиши. Например, если 0 передать для ESC, то форма перестанет закрываться по этой клавише и т.д

Описание: Событие вызывается при нажатии не системной клавиши.

Примечание: Не системная клавиша это клавиша нажатая без нажатия Alt и не F10.

ПриОтжатииКлавиши / OnKeyUp

Синтаксис: ПриОтжатииКлавиши(ВиртКод, Данные, Клавиатура, ФСО)

Параметры:
  • ВиртКод - тип: Число. Код виртуальной клавиши не системной.
  • Данные - тип: Число. Определяет счетчик повторения, скан-код и прочее. Подробнее см. MSDN: http://msdn.microsoft.com/en-us/library/ms646280(VS.85).aspx
  • Клавиатура - тип: Клавиатура. Ссылка на сервисный объект работы с состоянием клавиатуры.
  • ФСО - флаг стандартной обработки. При вызове равен 1. Установка в 0 отменяет штатную обработку.

Описание: Событие вызывается при отжатии не системной клавиши.

Примечание: Не системная клавиша это клавиша нажатая без нажатия Alt и не F10.

ПриНажатииСистемнойКлавиши / OnSysKeyDown

Синтаксис: ПриНажатииСистемнойКлавиши(ВиртКод, Данные, Клавиатура, ФСО)

Параметры:
  • ВиртКод - тип: Число. Код виртуальной клавиши системной.
  • Данные - тип: Число. Определяет счетчик повторения, скан-код и прочее. Подробнее см. MSDN: http://msdn.microsoft.com/en-us/library/ms646280(VS.85).aspx
  • Клавиатура - тип: Клавиатура. Ссылка на сервисный объект работы с состоянием клавиатуры.
  • ФСО - флаг стандартной обработки. При вызове равен 1. Установка в 0 отменяет штатную обработку.

Описание: Событие вызывается при нажатии системной клавиши.

Примечание: Системная клавиша это F10 или любая другая клавиша нажатая при удержании клавиши Alt

ПриОтжатииСистемнойКлавиши / OnSysKeyUp

Синтаксис: ПриОтжатииСистемнойКлавиши(ВиртКод, Данные, Клавиатура, ФСО)

Параметры:
  • ВиртКод - тип: Число. Код виртуальной клавиши системной.
  • Данные - тип: Число. Определяет счетчик повторения, скан-код и прочее. Подробнее см. MSDN: http://msdn.microsoft.com/en-us/library/ms646280(VS.85).aspx
  • Клавиатура - тип: Клавиатура. Ссылка на сервисный объект работы с состоянием клавиатуры.
  • ФСО - флаг стандартной обработки. При вызове равен 1. Установка в 0 отменяет штатную обработку.

Описание: Событие вызывается при отжатии системной клавиши.

Примечание: Системная клавиша это F10 или любая другая клавиша нажатая при удержании клавиши Alt

ПриВводеСимвола / OnChar

Синтаксис: ПриВводеСимвола(КодСимвола, Данные, Клавиатура, ФСО)

Параметры:
  • КодСимвола - тип: Число. Код символа нажатой клавиши.
  • Данные - тип: Число. Определяет счетчик повторения, скан-код и прочее. Подробнее см. MSDN: http://msdn.microsoft.com/en-us/library/ms646280(VS.85).aspx
  • Клавиатура - тип: Клавиатура. Ссылка на сервисный объект работы с состоянием клавиатуры.
  • ФСО - флаг стандартной обработки. При вызове равен 1. Установка в 0 отменяет штатную обработку.

Описание: Событие вызывается при нажатии клавиши, транслированной как символьная.

ПриВыводеПодсказки / OnShowHint

Синтаксис: ПриВыводеПодсказки(Подсказка, ФСО, Х, У, Строка, Колонка, ТипРегиона)

Параметры:

  • Подсказка - тип: Строка. Текст подсказки.
  • ФСО - тип: Число. Флаг стандартной обработки. Установка в 0 приведет к отмене стандартного вывода подсказки.
  • Х - тип: Число. Горизонтальное положение окна подсказки на экране.
  • У - тип: Число. Вертикальное положение окна подсказки на экране.
  • Строка - тип: определяется поставищком данных. Значение, идентифицирующее строку ТП.
  • Колонка - тип: КолонкаТабличногоПоля
  • ТипРегиона - тип: ТипыРегионовТП

Описание: Возникает при выводе (отображении) подсказки для ячейки табличного поля.

ПриФорматированииСтроки / OnRowFormat

Синтаксис ПриФорматированииСтроки(ФорматСтроки, ДанныеСтроки)

Параметры
  • ФорматСтроки - тип: Коллекция. Коллекция объектов типа ФорматЯчейки для доступа к ячейкам строки табличного поля с целью форматирования текста ячеек.
  • ДанныеСтроки - тип: ДанныеСтроки. Данные (коллекция значений полей) форматируемой строки табличного поля.

Описание: Событие вызывается когда появляется необходимость отформатировать текст ячеек табличного поля.

Примечание: Необходимость форматирования текста ячеек возникает при глобальном поиске по подстроке текста, а также при выполнении копирования в буфер обмена. Если событие ПриФорматированииСтроки не определено, то в целях форматирования текста ячеек будет вызываться событие ПриВыводеСтроки

ПриКомандеБуфераОбмена / OnClipboard

Синтаксис ПриКомандеБуфераОбмена(Команда, Текст, ФСО)

Параметры
  • Команда - тип: Число. 0- copy, 1- paste, 2- (M), 3- (M+), 4- (M-)
  • Текст - тип: Строка. При команде copy - текст текущей ячейки. При команде paste - текст содержимого буфера обмена. При командах M, M+, M- - строковое представление числа в текущей ячейке. При этом из строки убраны пробелы и символ ',' заменен на '.'
  • ФСО - тип: Число. Флаг стандартной обработки. Установка в 0 приведет к отмене стандартного действия.

Описание: Событие вызывается при командах работы с буфером обмена.

ПриПоиске / OnFind

Синтаксис ПриПоиске(ДанныеПоиска, ФСО)

Параметры
  • ДанныеПоиска - тип: ГлобальныеДанныеПоиска. Объект для доступа к параметрам поиска.
  • ФСО - тип: Число. Флаг стандартной обработки. Установка в 0 приведет к отмене стандартного поиска.

Описание: Событие вызывается перед запуском поиска.

Примечание: Существует возможность скорректировать данные поиска и/или заменить стандартный алгоритм поиска собственным алгоритмом. Если тип зачение ДанныеПоиска::Значение отличный от типа Строка, то выполняется поиск по значению. Иначе выполняется поиск по подстроке.

ПриДиалогеПоиска / OnFindDialog

Синтаксис ПриДиалогеПоиска(ДанныеПоиска, ФСО)

Параметры
  • ДанныеПоиска - тип: ГлобальныеДанныеПоиска. Объект для доступа к параметрам поиска.
  • ФСО - тип: Число. Флаг стандартной обработки. Установка в 0 приведет к отмене открытия стандартного диалога.

Описание: Событие вызывается перед открытием диалога настройки поиска.

Примечание: Существует возможность скорректировать данные поиска и/или заменить стандартный диалог настройки поиска собственным.

КолонкиТабличногоПоля

Коллекция колонок табличного поля. Элементы коллекции - объекты типа КолонкаТабличногоПоля. Индексы колонок - от нуля до количества колонок минус один.

Свойства

<ИмяКолонки>

Доступ: только чтение.

Тип: КолонкаТабличногоПоля.

Описание: Набор свойств содержит значения полей колонок табличного поля. Доступ к значению осуществляется по имени колонки. Имена свойств совпадают с именами колонок табличного поля.

Методы

Количество / Count

Синтаксис: Количество()

Возвращает: тип: Число, количество колонок.

Описание: Получить количество колонок.

Получить / Get

Синтаксис: Получить(Колонка)

Параметры:

  • Колонка - тип: Число, Строка. Индекс или имя колонки.

Возвращает: тип: КолонкаТабличногоПоля.

Описание: Получить колонку табличного поля.

Индекс / IndexOf

Синтаксис: Индекс(Колонка)

Параметры:

Возвращает: тип: Число - индекс колонки, или -1, если колонка не принадлежит табличному полю.

Описание: Получить индекс колонки.

Добавить / Add

Синтаксис: Добавить(Имя)

Параметры:

  • Имя - тип: Строка. Имя добавляемой колонки.

Возвращает: тип: КолонкаТабличногоПоля - созданная колонка.

Описание: Добавляет колонку в табличное поле.

Вставить / Insert

Синтаксис: Вставить(Имя,Индкс)

Параметры:

  • Имя - тип: Строка. Имя вставляемой колонки.
  • Индекс - тип: Число. Индекс вставляемой колонки.

Возвращает: тип: КолонкаТабличногоПоля - созданная колонка.

Описание: Вставляет колонку в табличное поле.

Удалить / Remove

Синтаксис: Удалить(Индекс)

Параметры:

  • Индекс - тип: Число, Строка. Индекс или имя удаляемой колонки.

Описание: Удаляет колонку из табличного поля.

Очистить / Clear

Синтаксис: Очистить()

Описание: Удаляет все колонки в табличном поле.

Сдвинуть / Move

Синтаксис: Сдвинуть(Индекс, Смещение)

Параметры:

  • Индекс - тип: Число, индекс колонки, которую необходимо сдвинуть;
  • Смещение - тип: Число, если положительное, колонка сдвигается вправо (ее индекс увеличивается), если отрицательное, сдвигается влево.

Возвращает: тип: КолонкаТабличногоПоля - созданная колонка.

Описание: Сдвигает позицию колоки на указанное смещение.

КолонкаТабличногоПоля

Объект для управления колонкой табличного поля.

Свойства

Имя / Name

Доступ: чтение и запись.

Тип: Строка.

Описание: Имя колонки.

Заголовок / Caption

Доступ: чтение и запись.

Тип: Строка.

Описание: Текст заголовка колонки.

Видимость / Visible

Доступ: чтение и запись.

Тип: Число.

Описание: Видимость колонки. 0 - невидима, 1 - видима.

Ширина / Width

Доступ: чтение и запись.

Тип: Число.

Описание: Ширина колонки в пикселях.

АвтоШирина / AutoWidth

Доступ: Чтение

Тип: Число

Описание: Минимальная достаточная ширина колонки в пикселях, рассчитанная по видимой части ТП

ГоризонтальноеВыравнивание / HorizontalAlignment

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет правило выравнивания текста в ячейках колонки по горизонтали.

  • 0 - автоматически, в зависимости от типа поля данных, отображаемого в колонке;
  • 1 - прижать влево;
  • 2 - прижать вправо;
  • 3 - центрировать.

ИзменениеРазмера / SizeChange

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет возможность интерактивного изменения ширины колонки. 0 - запрещено, 1 - разрешено.

ЦветТекста / TextColor

Доступ: чтение и запись.

Тип: Число.

Описание: Цвет текста строк. Приоритет выше, чем у свойства ЦветТекста табличного поля.

ЦветФона / BackColor

Доступ: чтение и запись.

Тип: Число.

Описание: Цвет фона строк. Приоритет выше, чем у свойства ЦветФона табличного поля.

Шрифт / Font

Доступ: чтение и запись.

Тип: Шрифт.

Описание: Шрифт строк. Приоритет выше, чем у свойства Шрифт табличного поля.

ШрифтЗаголовка / HeaderFont

Доступ: чтение и запись.

Тип: Шрифт.

Описание: Шрифт заголовка. Приоритет выше, чем у свойства Шрифт табличного поля.

ЦветТекстаЗаголовка / HeaderTextColor

Доступ: чтение и запись.

Тип: Число.

Описание: Цвет текста заголовка.

ЦветФонаЗаголовка / HeaderBackColor

Доступ: чтение и запись.

Тип: Число.

Описание: Цвет фона заголовка.

Данные / DataField

Доступ: чтение и запись.

Тип: Строка.

Описание: Имя поля данных в поставщике данных. Если не указано, или указано неверно - это не является ошибкой, в этом случае никакие данные поставщика данных в этой колонке не отображаются.

См. также: Поставщики данных табличного поля

ДанныеКартинки / PictureDataField

Доступ: чтение и запись.

Тип: Строка, Число (см. Примечание)

Описание: Имя поля данных в поставщике данных для отображения картинок. Если поле данных не указано, или указано неверно - это не является ошибкой; в этом случае привязка картинок к полю данных не осуществляется.

Формат данных соответствует формату данных свойства ИндексКартинки объекта ОформлениеЯчейки.

См. также: Поставщики данных табличного поля

Примечание: Картинку с нулевым индексом можно задавать только строкой.

ЗнакУпорядочивания / OrderMarker

Доступ: чтение и запись.

Тип: Число

Описание: Определяет вывод значка упорядочивания в заголовке колонки.

  • 0 - не отображается;
  • 1 - по возрастанию;
  • 2 - по убыванию;
  • 3 - по возрастанию второе поле;
  • 4 - по убыванию второе поле;
  • 5 - по возрастанию третье поле;
  • 6 - по убыванию третье поле;

ИзменятьВидимость / ChangeVisible

Доступ: чтение и запись.

Тип: Число

Описание: Разрешает или запрещает изменять видимость колонки. 0 - запрещает, 1- разрешает.

Параметр / Parameter

Доступ: чтение и запись.

Тип: Любой

Описание: Дополнительный параметр колонки для хранения произвольных данных

Положение / Location

Доступ: чтение и запись.

Тип: Число

Описание: Определяет положение колонки относительно предыдущей колонки.

  • 0 - новая колонка;
  • 1 - на следующей строке;
  • 2 - в той же колонке;

ПереноситьПоСловам / WordBreak

Доступ: чтение и запись.

Тип: Число

Описание: 1 - преносить текст по словам, 0 - выводить текст в одну строку.

Формат / Format

Доступ: чтение и запись.

Тип: Строка

Описание: форматная строка для форматирования содержимого ячеек колонки. Виды форматной строки см. в описании системной функции Формат.

ВыделятьОтрицательные / MarkNegatives

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет необходимость выделения цветом текста начинающегося на знак "-" (минус).

ПрозрачностьФона / BackTransparency

Доступ: чтение и запись.

Тип: Число.

Описание: Значение прозрачности фона ячеек колонки. Приоритет выше, чем у свойства ПрозрачностьФонаЯчеек табличного поля.

Свойство может принмать значения от 0 до 255 При значении свойства равном 0 прозрачность ячеек отключается - ячейки не прозрачны. При значении свойства равном 255 прозрачность ячеек максимальная - фон ячеек не выводится.

Методы

УстановитьКартинкиСтрок / SetRowsPictures

Синтаксис: УстановитьКартинкиСтрок(Картинки, Ширина)

Параметры:

  • Картинки - тип: Картинка. Картинка - из которой будут получены отдельные пиктограммы для отображения в ячейках.
  • Ширина - тип: Число. Необязателен, по умолчанию 0. Ширина отдельной пиктограммы для отображения. Если равна нулю, ширина определяется высотой переданной картинки.

Описание: Устанавливает набор картинок для отображения в ячейках этой колонки. Картинками считаются части общей переданной первым параметром картинки, полученные по следующим правилам: от левого верхнего угла слева направо, ширина равна высоте. Выбирается только первый ряд. Прозрачным является цвет RGB(0x00, 0x80, 0x80). Картинки будут доступны по индексу (от нуля).

ДобавитьКартинкиСтрок / AddRowsPictures

Синтаксис: ДобавитьКартинкиСтрок(Картинки)

Параметры:

  • Картинки - тип: Картинка. Картинка - из которой будут получены отдельные пиктограммы для отображения в ячейках.

Описание: Дополняет набор картинок для отображения в ячейках этой колонки.

Метод допустимо вызывать для дополнения коллекции картинок после установки методом УстановитьКартинкиСтрок. Ширина отдельных пиктограмм равна ширине указанной при вызове метода УстановитьКартинкиСтрок.

СброситьКартинкиСтрок / ResetRowsPictures

Синтаксис: СброситьКартинкиСтрок()

Описание: Очищает набор картинок этой колонки.

ДанныеСтроки

Фиксированная коллекция значений полей данных, полученных табличным полем от поставщика данных. Элементы коллекции - значения полей поставщика.

Свойства

<ИмяПоляДанных>

Доступ: только чтение.

Тип: любой. Тип определяется поставщиком данных.

Описание: Набор свойств содержит значения значения полей данных. Доступ к значению осуществляется по имени поля данных. Набор полей данных обеспечивается поставщиком данных.

См. также: Поставщики данных табличного поля

Методы

Количество / Count

Синтаксис: Количество()

Возвращает: тип: Число, количество полей.

Описание: Получить количество полей данных.

Получить / Get

Синтаксис: Получить(Поле)

Параметры:

  • Поле - тип: Число, Строка. Имя или индекс поля данных.

Возвращает: тип: Любой. Значение поля данных

Описание: Получить значение поля.

Индекс / IndexOf

Синтаксис: Индекс(Поле)

Параметры:

  • Поле - тип: Строка. Имя поля, индекс которого требуется получить.

Возвращает: тип: Число - индекс поля, или -1, если поля с таким именем не существует.

Описание: Получить индекс поля.

ОформлениеСтроки

Объект для управления оформлением строки табличного поля.

Свойства

ДанныеСтроки / RowData

Доступ: только чтение.

Тип: ДанныеСтроки.

Описание: Данные строки. Коллекция значений полей для строки табличного поля.

Ячейки / Cells

Доступ: только чтение.

Тип: ФиксированнаяКоллекция.

Описание: Коллекция ячеек строки табличного поля. Элементы коллекции - объекты типа ОформлениеЯчейки.

ЦветТекста / TextColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет текста всех ячеек строки. Приоритет выше, чем у свойства ЦветТекста колонки табличного поля.

ЦветФона / BackColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет текста всех ячеек строки. Приоритет выше, чем у свойства ЦветТекста колонки табличного поля.

Шрифт / Font

Доступ: чтение и запись.

Тип: Шрифт.

Описание: Определяет Шрифт всех ячеек строки. Приоритет выше, чем у свойства Шрифт колонки табличного поля.

ПрозрачностьФона / BackTransparency

Доступ: чтение и запись.

Тип: Число.

Описание: Значение прозрачности фона ячеек строки. Приоритет выше, чем у свойства ПрозрачностьФона колонки.

Свойство может принмать значения от 0 до 255 При значении свойства равном 0 прозрачность ячеек отключается - ячейки не прозрачны. При значении свойства равном 255 прозрачность ячеек максимальная - фон ячеек не выводится.

ОформлениеЯчейки

Объект для управления оформлением ячейки табличного поля. В ячейку табличного поля могут выводится различные пиктограммы и текст. При этом определен следующий порядок следования слева направо:

  • Системные картинки табличного поля
  • Флажок
  • Картинки колонки
  • Текст

Свойства

Имя / Name

Доступ: только чтение.

Тип: Строка.

Описание: Имя ячейки. Соответствует имени колонки, которой принадлежит ячейка.

ОтображатьТекст / ShowText

Доступ: чтение и запись.

Тип: Число.

Описание: Признак отображения текста в ячейке. 0 - не отображать, 1 - отображать.

ОтображатьКартинку / ShowPicture

Доступ: чтение и запись.

Тип: Число.

Описание: Признак отображения картинки в ячейке. 0 - не отображать, 1 - отображать.

ОтображатьСистемнуюКартинку / ShowSysPicture

Доступ: чтение и запись.

Тип: Число.

Описание: Признак отображения системной картинки в ячейке. 0 - не отображать, 1 - отображать.

ОтображатьФлажок / ShowCheck

Доступ: чтение и запись.

Тип: Число.

Описание: Признак отображения флажка в ячейке. 0 - не отображать, 1 - отображать.

ГоризонтальноеВыравнивание / HorizontalAlignment

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет правило выравнивания текста в ячейке по горизонтали.

  • 0 - автоматически, в зависимости от типа поля данных, отображаемого в колонке;
  • 1 - прижать влево;
  • 2 - прижать вправо;
  • 3 - центрировать.

Картинки / Pictures

Доступ: чтение

Тип: ИндексыКартинок

Описание: Определяет коллекцию индексов картинкок для отображения в ячейке. Картинки должны быть предварительно установлены в соответствующей колонке.

См. также: свойство УстановитьКартинкиСтрок и ДобавитьКартинкиСтрок, объекта КолонкаТабличногоПоля.

ИндексКартинки / PictureIndex

Доступ: чтение и запись.

Тип: Число, Строка.

Описание: Определяет индекс картинки для отображения в ячейке. Возможно использование строки - списка индексов, разделенных запятыми. Картинки должны быть предварительно установлены в соответствующей колонке.

См. также: свойство УстановитьКартинкиСтрок и ДобавитьКартинкиСтрок, объекта КолонкаТабличногоПоля.

СистемныеКартинки / SysPictures

Доступ: чтение

Тип: ИндексыКартинок

Описание: Определяет коллекцию индексов системных картинкок для отображения в ячейке. Системные картинки должны быть предварительно установлены в табличном поле.

См. также: свойство УстановитьСистемныеКартинки / SetSysPictures и ДобавитьСистемныеКартинки / AddSysPictures, объекта ТабличноеПоле.

ИндексСистемнойКартинки / SysPictureIndex

Доступ: чтение и запись.

Тип: Число, Строка.

Описание: Определяет индекс системной картинки для отображения в ячейке. Возможно использование строки - списка индексов, разделенных запятыми. Системные картинки должны быть предварительно установлены в табличном поле.

См. также: свойство УстановитьСистемныеКартинки / SetSysPictures и ДобавитьСистемныеКартинки / AddSysPictures, объекта ТабличноеПоле.

ЗначениеФлажка / CheckValue

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет значение флажка ячейки табличного поля. Значение флажка отображаемого в ячейке.

  • 0 - не установлен;
  • 1 - установлен;
  • 2 - неопределенное состояние.

Текст / Text

Доступ: чтение и запись.

Тип: Строка.

Описание: Определяет текст ячейки табличного поля.

ЦветТекста / TextColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет текста ячейки табличного поля. Приоритет выше, чем у свойства ЦветТекста строки табличного поля.

ЦветФона / BackColor

Доступ: чтение и запись.

Тип: Число.

Описание: Определяет цвет фона ячейки табличного поля. Приоритет выше, чем у свойства ЦветФона строки табличного поля.

Шрифт / Font

Доступ: чтение и запись.

Тип: Шрифт.

Описание: Определяет шрифт текста ячейки табличного поля. Приоритет выше, чем у свойства Шрифт строки табличного поля.

ПереноситьПоСловам / WordBreak

Доступ: чтение и запись.

Тип: Число

Описание: 1 - преносить текст по словам, 0 - выводить текст в одну строку.

ОтображатьПодсказку / ShowHint

Доступ: чтение и запись.

Тип: Число.

Описание: Признак отображения произвольной подсказки. 0 - не отображать, 1 - отображать.

Подсказка / Hint

Доступ: чтение и запись.

Тип: Строка.

Описание: Определяет текст произвольной подсказки для ячейки табличного поля.

ПрозрачностьФона / BackTransparency

Доступ: чтение и запись.

Тип: Число.

Описание: Значение прозрачности фона ячейки. Приоритет выше, чем у свойства ПрозрачностьФона строки табличного поля.

Свойство может принмать значения от 0 до 255 При значении свойства равном 0 прозрачность ячейки отключается - ячейка не прозрачна. При значении свойства равном 255 прозрачность ячейки максимальная - фон ячейки не выводится.

Методы

УстановитьТекст / SetText

Синтаксис:

УстановитьТекст(стрТекст)
Параметры:
  • стрТекст, тип: Строка.

    Текст, отображаемый в ячейке.
Возвращает:

нет
Описание:

Устанавливает текст ячейки табличного поля для отображения и свойство ОтображатьТекст в 1.

УстановитьКартинку / SetPicture

Синтаксис:

УстановитьКартинку(Картинка)
Параметры:
  • Картинка, тип: Картинка, Число, Строка

    Картинка, индекс картинки, или перечисление индексов картинок через запятую
Возвращает:

нет
Описание:
Устанавливает картинку ячейки табличного поля и свойство ОтображатьКартинку в 1.
Если передано Число, это должен быть индекс пиктограммы в картинке, переданной в метод КолонкаТабличногоПоля::УстановитьКартинкиСтрок;
Если передана Строка, это должен быть спискок индексов пиктограмм в картинке, переданной в метод КолонкаТабличногоПоля::УстановитьКартинкиСтрок;
Если передан объект Картинка, то отображается сама переданная картинка. Картинка отображается без использования цвета прозрачности. Правила масштабирования картинки задаются в объекте Картинка.
Масштабирование вывода картинки идет всегда с сохранением пропорций её оригинальных размеров и зависит от режима рисования (Картинка::РежимРисования()):
  • 1 - картинка отображается по оригинальным размерам или если они больше ячейки, то по размерам ячейки;
  • 2 - картинка отображается по оригинальным размерам (если они больше размеров ячейки - мы увидим не всю картинку, а только левый верхний угол картинки);
  • 3 - картинка отображается по размерам ячейки;

УстановитьСистемнуюКартинку / SetSysPicture

Синтаксис:

УстановитьСистемнуюКартинку(Картинка)
Параметры:
  • Картинка, тип: Число, Строка. Индекс картинки, или перечисление индексов картинок через запятую
Описание:
Устанавливает картинку ячейки табличного поля и свойство ОтображатьСистемнуюКартинку в 1.
Если передано Число, это должен быть индекс пиктограммы в картинке, переданной в метод УстановитьСистемныеКартинки или ДобавитьСистемныеКартинки;
Если передана Строка, это должен быть спискок индексов пиктограмм в картинке, переданной в метод УстановитьСистемныеКартинки или ДобавитьСистемныеКартинки;

УстановитьФлажок / SetCheck

Синтаксис:

УстановитьФлажок(ЗначениеФлажка)
Параметры:
  • ЗначениеФлажка, тип: Число

    Значение флажка, отображаемого в ячейке

    • 0 – не установлен;
    • 1 – установлен;
    • 2 – неопределенное состояние.
Возвращает:

нет
Описание:

Устанавливает значение флажка ячейки табличного поля и свойство ОтображатьФлажок в 1.

УстановитьПодсказку / SetHint

Синтаксис:

УстановитьПодсказку(стрПодсказка)
Параметры:
  • стрПодсказка, тип: Строка.

    Текст, отображаемый при выводе произвольной подсказки.
Возвращает:

нет
Описание:

Устанавливает текст произвольной подсказки и свойство ОтображатьПодсказку в 1.

ФорматЯчейки

Объект для управления текстовым представлением ячейки при операциях поиска по подстроке и работы с буфером обмена.

Свойства

Имя / Name

Доступ: только чтение.

Тип: Строка.

Описание: Имя ячейки. Соответствует имени колонки, которой принадлежит ячейка.

ОтображатьТекст / ShowText

Доступ: чтение и запись.

Тип: Число.

Описание: свойство не несет смысловой нагрузки и реализовано только для структурной совместимости с обектом ОформлениеЯчейки.

Текст / Text

Доступ: чтение и запись.

Тип: Строка.

Описание: Определяет текстовое представление ячейки табличного поля.

Методы

УстановитьТекст / SetText

Синтаксис:
УстановитьТекст(стрТекст)

Параметры:

  • стрТекст, тип: Строка.

    Текстовое представление ячейки.

Возвращает:
нет

Описание: Устанавливает текстовое представление ячейки табличного поля и свойство ОтображатьТекст в 1.

ИндексыКартинок

Коллекция индексов картинок для отображения в ячейке табличного поля.

Тип элемента коллекции: Число. Индексы элементов коллекции - числа от нуля до количества элементов минус один.

Картинки должны быть предварительно установлены в соответствующей колонке. См. также: УстановитьКартинкиСтрок, ДобавитьКартинкиСтрок, УстановитьСистемныеКартинки, ДобавитьСистемныеКартинки, объекта КолонкаТабличногоПоля.

Методы

Количество / Count

Синтаксис:Количество()
Параметры:нет
Возвращает:Количество элементов коллекции; тип: Число
Описание:Возвращает количество элементов коллекции

Получить / Get

Синтаксис:

Получить(Индекс)
Параметры:
  • Индекс, тип: Число

    Индекс элемента коллекции; может принимать значения от 0 до Количество() - 1
Возвращает:

Значение элемента коллекции; тип: Число
Описание:

Получает значение элемента коллекции по его индексу

Выгрузить / Unload

Синтаксис:

Выгрузить(Список)
Параметры:
  • Список, тип: СписокЗначений

    Список значений, в который будут выгружены элементы коллекции
Возвращает:

Нет
Описание:

Выгружает коллекцию в список значений

Установить / Set

Синтаксис:

Установить(Индекс, Значение)
Параметры:
  • Индекс, тип: Число

    Индекс элемента коллекции

  • Значение, тип: Число

    Значение элемента коллекции
Возвращает:

Нет
Описание:

Устанавливает значение элемента коллекции по его индексу

Добавить / Add

Синтаксис:

Добавить(Значение)
Параметры:
  • Значение, тип: Число

    Значение элемента коллекции
Возвращает:

Нет
Описание:

Добавляет новый элемент коллекции с заданным значением

Удалить / Remove

Синтаксис:

Удалить(Индекс)
Параметры:
  • Индекс, тип: Число

    Индекс элемента коллекции
Возвращает:

Нет
Описание:

Удаляет заданный элемент из коллекции

Очистить / Clear

Синтаксис:Очистить()
Параметры:Нет
Возвращает:Нет
Описание:Удаляет все элементы коллекции

Вставить / Insert

Синтаксис:

Вставить(Индекс, Значение)
Параметры:
  • Индекс, тип: Число

    Индекс элемента коллекции

  • Значение, тип: Число

    Значение элемента коллекции
Возвращает:

Нет
Описание:

Добавляет новый элемент коллекции перед элементом с заданным индексом

Сдвинуть / Move

Синтаксис:

Сдвинуть(Индекс, Смещение)
Параметры:
  • Индекс, тип: Число

    Индекс элемента коллекции

  • Смещение, тип: Число

    Смещение элемента коллекции относительно его текущего положения
Возвращает:

Нет
Описание:

Перемещает заданный элемент коллекции, в соответствии с указанным смещением. Положительные смещения перемещеют элемент вправо (в сторону больших индексов), отрицательные - влево.

ВыделенныеСтроки

Коллекция выделенных строк табличного поля

Коллекцией можно управлять как интерактивно, так и программно.

Возможно выделение несвязанных строк с помощью мыши или клавиатуры при нажатой клавише CTRL, а также выделение диапазонов строк с помощью мыши при нажатой клавише SHIFT.

Для корректной работы механизма выделения строк необходимо, чтобы поставщик реализовал интерфейс CV7DataProvider (преобразование строки в значение, идентифицирующее строку). Например, для поставщика данных ODBC необходима установка поля ИД методом УстИДПоле.

Методы

Количество / Count

Синтаксис:Количество()
Параметры:нет
Возвращает:Количество выделенных строк ТП; тип: Число
Описание:

Очистить / Clear

Синтаксис:Очистить()
Параметры:нет
Возвращает:нет
Описание:Снимает выделение со всех строк ТП

Получить / Get

Синтаксис:

Получить(Индекс)
Параметры:
  • Индекс, тип: Число

    Индекс строки; может принимать значения от 0 до Количество() - 1
Возвращает:

Значение строки; тип задается поставщиком данных
Описание:

Получает значение выделенной строки ТП по ее индексу в коллекции

Добавить / Add

Синтаксис:

Добавить(Значение)
Параметры:
  • Значение, тип задается поставщиком данных

    Значение строки ТП
Возвращает:

нет
Описание:

Устанавливает выделение указанной строки ТП

Удалить / Delete

Синтаксис:

Удалить(Значение)
Параметры:
  • Значение, тип задается поставщиком данных

    Значение строки ТП
Возвращает:

нет
Описание:

Снимает выделение указанной строки ТП

Содержит / Contains

Синтаксис:

Содержит(Значение)
Параметры:
  • Значение, тип задается поставщиком данных

    Значение строки ТП
Возвращает:
  • 0 - не содержит
  • 1 - содержит
Описание:

Определяет, содержит ли в данная коллекция выделенных строк указанную строку ТП

ФиксированныеСтроки

Объект, предназначенный для управления регионами фиксированных строк ТП (Шапка и Подвал)

Свойства

ПоставщикДанных / DataProvider

Доступ:Чтение и запись
Тип:Поставщики данных табличного поля
Описание:Поставщик данных соответствующего региона ТП

ЦветТекста / TextColor

Доступ:Чтение и запись
Тип:Число
Описание:Цвет текста соответствующего региона ТП

ЦветФона / BackColor

Доступ:Чтение и запись
Тип:Число
Описание:Цвет фона соответствующего региона ТП

ПрозрачностьФона / BackTransparency

Доступ: чтение и запись.

Тип: Число.

Описание: Значение прозрачности фона ячеек фиксированных строк.

Свойство может принмать значения от 0 до 255 При значении свойства равном 0 прозрачность ячеек отключается - ячейки не прозрачны. При значении свойства равном 255 прозрачность ячеек максимальная - фон ячеек не выводится.

Методы

ОбновитьСтроки / RefreshRows

Синтаксис:ОбновитьСтроки()
Описание:Обновляет данные поставщика и заново отрисовывает табличное поле

ПерерисоватьСтроки / RedrawRows

Синтаксис:ПерерисоватьСтроки()
Описание:Обновить строки, отображаемые в данный момент в табличном поле, без обращения к провайдеру.

Типы данных

Общие

Перечисления

ТипыРегионовТП

Значения:
  • 0 - регион не задан
  • 1 - заголовок
  • 2 - шапка
  • 3 - строки (основная часть)
  • 4 - подвал

ТипыОбластейЯчейки

Значения:
  • -1 - область не определена
  • 0 - область текста
  • 1 - область картинки
  • 2 - область флажка
  • 3 - область системной картинки

Структуры

ГлобальныеДанныеПоиска

Поля:
  • Значение/Value - значение поиска. Может быть типов: Строка, Число, Дата, ЛюбаяСсылка. Если тип отличный от типа Строка, то выполняется поиск по значению. Иначе выполняется поиск по подстроке
  • Строка/String - строка поиска
  • Назад/Back - 0 - поиск вперед, 1 - поиск в обратном направлении
  • УчитыватьРегистр/CS - 0 - регистронезависимый поиск, 1 - регистрозависимый поиск
  • ПоОднойКолонке/OneCol - 0 - поиск по всем колонкам, 1 - поиск только по текущей колонке

Поставщики данных табличного поля

См. также|_1cpp_table_data_providers_

ПоставщикДанныхODBC.<ТипИсточника> / ODBCDataProvider

Используется для отображения в табличном поле таблиц баз данных. Для получения данных используется драйвер ODBC. Подключение задается объектом ODBCDataBase|_1cpp_odbc_Database.

Получаемые данные определяются SQL запросом. Формат SQL запроса определяется строже, чем общий формат SQL запроса источника данных или драйвера ODBC.

Возможно использование метаимен и типизации полей, как определено для объекта ODBCRecordset|_1cpp_odbc_recordset в Приложении А|_1cpp_SQLQuery_Metanames. Данные получаются частями по несколько записей, как это необходимо для отображения.

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

Формат запроса:

<Запрос> ::=
SELECT
<ОпределениеПоля> [, …n]
FROM <ИсточникДанных>
[WHERE <Условие>]

<ОпределениеПоля> ::= <ВыражениеПоля> AS <ИмяПоля>
<ВыражениеПоля> ::= <определяется правилами источника данных>
<ИмяПоля> ::= <определяется правилами источника данных>
<ИсточникДанных> ::= <определяется правилами источника данных>
<Условие> ::= <определяется правилами источника данных>

Кроме текста запроса, для работы также необходимо задать ключ порядка. Ключ порядка - это набор полей с указанием упорядочивания (порядка следования записей). Значения этих полей должны однозначно идентифицировать каждую запись.

Формат ключа порядка:

<КлючПорядка> ::= <ЭлементКлючаПорядка> [, …n]
<ЭлементКлючаПорядка> ::= <ИмяПоля> {[ASC] | DESC}

В ключе порядка имя поля необходимо указывать без типизации. (Обратите внимание, что поля из ключа порядка должны быть обязательно определены в запросе.)

В тексте запроса допустимо использование текстовых параметров. Формат определения текстового параметра в тексте запроса:

:<ИмяПараметра> [<Модификатор>]

Возможно использование модификаторов, как определено для объекта ODBCRecordset|_1cpp_odbc_recordset. Текстовые параметры должны быть установлены до установки текста запроса.

В тексте запроса допустимо использование SQL параметров. Формат определения SQL параметра в тексте запроса:

?<ИмяПараметра>(Тип[, Длина[, Точность]])

После установки текста запроса, доступ значениям параметров обеспечивается коллекцией параметров поставщика данных.

Свойство ТекущаяСтрока табличного поля:

  • принимает значение идентифицирующего поля в случае, когда идентифицирующее поле было определено методом УстИДПоле.
  • в случае если идентифицирующее поле не было определено - то свойство ТекущаяСтрока при чтении будет возвращать значение неопределенного типа. При записи в это свойство допустимо передавать объект, в свойствах которого будут значения для ключа порядка текущей строки.

<ТипИсточника>

Определяет тип источника данных. От типа источника зависит стиль конечных запросов к серверу. От типа источника также могут зависеть способы и возможности оптимизации. Определены следующие типы источников данных:

MSSQL:Источником данных должен быть Microsoft SQL Server 7.0 или Microsoft SQL Server 2000. Рекомендуется драйвер: {SQL Server}.
VFP:Источником данных должны быть dbf файлы. Рекомендуется драйвер: {Microsoft Visual FoxPro Driver}.
MySQL:Источником должен быть MySQL Server. Рекомендуется драйвер: {MySQL ODBC 3.51 Driver}.
Oracle:Источником должен быть Oracle8i Database. Рекомендуется драйвер: {Microsoft ODBC для Oracle} или {Oracle ODBC Driver}.

Свойства

Поля / Fields

Доступ: только чтение.

Тип: ПоляДанныхODBC.

Описание: Коллекция полей поставщика данных.

БазаДанных / Database

Доступ: чтение и запись.

Тип: ODBCDataBase|_1cpp_odbc_Database.

Описание: Определяет подключение, через которое поставщик данных будет работать.

Параметры / Params

Доступ: только чтение.

Тип: ПараметрыЗапроса.

Описание: Коллекция параметров запроса.

Методы

УстТекстЗапроса / SetQueryText

Синтаксис: УстТекстЗапроса(ТекстЗапроса)

Параметры:

  • ТекстЗапроса - тип: Строка. Текст запроса, определяющий данные, которые будет выдавать поставщик данных.

Описание: Устанавливает текст запроса. При этом происходит сброс ключа порядка, сброс установки идентификационного поля. Происходит полная инициализация состояния поставщика данных. При установке текста запроса происходит также парсинг текста запроса парсером метаимен, как определено для объекта ODBCRecordset|_1cpp_odbc_recordset.

Примечание: Сразу после установки текста запроса поставщик данных находится в неработоспособном состоянии, т.к. происходит сброс, без ключа порядка он работать не может.

УстКлючПорядка / SetOrderKey

Синтаксис: УстКлючПорядка(КлючПорядка)

Параметры:

  • КлючПорядка - тип: Строка. Текст ключа порядка.

Описание: Установка возможна только после установки текста запроса.

УстановитьТекстовыйПараметр / SetTextParam

Синтаксис: УстановитьТекстовыйПараметр(ИмяПараметра, ЗначениеПараметра)

Параметры:

  • ИмяПараметра - тип: Строка. Имя параметра.
  • ЗначениеПараметра - тип: Строка. Значение параметра.

Описание: Устанавливает значение параметра.

УстИДПоле / SetIDField

Синтаксис: УстИДПоле(ИмяПоля)

Параметры:

  • ИмяПоля - тип: Строка. Имя поля.

Описание: Устанавливает поле, которое будет принято поставщиком данных как поле, идентифицирующее строку данных. Значение этого поля будет обеспечиваться поставщиком данных, как значение для свойства ТекущаяСтрока табличного поля.

Обновить / Refresh

Синтаксис: Обновить(ТекущаяСтрока)

Параметры:

  • ТекущаяСтрока - тип: любой. Необязателен. Зависит от установки идентифицирующего поля.

Описание: Если параметр не указан, то происходит начальное заполнение табличного поля, учитывая значение свойства табличного поля НачальноеПредставление. Если указан параметр, то начальное заполнение табличного поля произойдет с активизацией переданной текущей строки.

Текущую строку можно задавать двумя способами:

  • Если установлено идентифицирующее поле, то можно передать значение идентифицирующего поля.
  • Можно передать любой объект, имеющий свойства с именами полей ключа порядка, и соответствующими значениями этих свойств, как значения полей ключа порядка необходимой текущей строки. Например - объект типа Структрура.

Отладка / Debug

Синтаксис: Отладка(флРежим = 1)

Параметры:

  • флРежим - тип: Число.
    • 1 - вкл. отладку
    • 0 - откл. отладку

Описание: включает / отключает отладочный режим.

ПолучитьТекстЗапроса / GetQueryText

Синтаксис: ПолучитьТекстЗапроса()

Параметры:

  • нет

Описание: возвращает текст запроса

ПоляДанныхODBC

Коллекция полей поставщика данных. Элементы коллекции - объекты типа ПолеДанныхODBC. Состав коллекции определяет набор полей запроса, который будет запрашиваться с сервера через драйвер ODBC.

Свойства

<ИмяПоля>

Доступ: только чтение.

Тип: ПолеДанныхODBC.

Описание: Набор свойств содержит значения объекты для управления полями данных. Доступ осуществляется по имени поля данных.

Методы

Количество / Count

Синтаксис: Количество()

Возвращает: тип: Число. Количество элементов.

Описание: Получить количество элементов.

Получить / Get

Синтаксис: Получить(Поле)

Параметры:

  • Поле - тип: Число, Строка. Индекс или имя поля.

Возвращает: тип: ПолеДанныхODBC.

Описание: Получить поле поставщика данных по индексу или номеру.

Добавить / Add

Синтаксис: Добавить(Имя)

Параметры:

  • Имя - тип: Строка. Имя добавляемого поля запроса.

Возвращает: тип: ПолеДанныхODBC. Добавленное поле.

Описание: Добавляет поле в список получаемых от источника данных. Поле с таким именем должно быть определено в запросе. Если поле с таким именем уже присутствует с коллекции - добавления не происходит.

Удалить / Remove

Синтаксис: Удалить(Индекс)

Параметры:

  • Индекс - тип: Число, Строка. Индекс или имя удаляемого поля.

Описание: Удаляет поле из списка получаемых от источника данных. Поля, входящие в состав ключа порядка, и идентифицирующее поле - удалить невозможно.

Очистить / Clear

Синтаксис: Очистить()

Описание: Удаляет все поля из списка, кроме полей, входящих в состав ключа порядка. Поля, входящие в состав ключа порядка, и идентифицирующее поле - удалить невозможно.

ПолеДанныхODBC

Объект для управления полем поставщика данных.

Свойства

Имя / Name

Доступ: только чтение.

Тип: Строка.

Описание: Имя поля.

АвтоУдаление / AutoDelete

Доступ: чтение и запись.

Тип: Число.

Описание: Признак разрешения автоматического удаления поля из состава получаемых данных от источника. 0 - запрещено, 1 - разрешено.

ТипБыстрогоПоиска / QuickSearchType

Доступ: чтение и запись.

Тип: Число.

Описание: Тип быстрого поиска определенного для этого поля. Быстрый поиск может проводиться интерактивно в табличном поле. Быстрый поиск ведется поставщиком данных только по первому полю ключа порядка, поэтому тип быстрого поиска должен определять тип данных этого поля.

  • 0 - нет быстрого поиска;
  • 1 - текстовый быстрый поиск.

УсловиеБыстрогоПоиска / QuickSearchCondition

Доступ: чтение и запись.

Тип: Строка.

Описание: Определяет дополнительное условие, которое будет включено по "И" в SQL запрос для быстрого поиска.

Примечание: ВНИМАНИЕ! Эта часть запроса не обрабатывается парсером метаимен.

Типизация / Typification

Доступ:чтение и записаь
Тип:Строка вида "Справочник.*", "Документ.*" и т.д., без имени поля и знака "$"
Описание:Предоставляет возможность альтернативной спецификации типизирующих полей запроса.

ПараметрыЗапроса

Коллекция значений SQL параметров запроса. Состав коллекции определяется при установке текста запроса.

Свойства

<ИмяПараметра>

Доступ: чтение и запись.

Тип: любой.

Описание: Набор свойств содержит значения SQL параметров определенных в тексте запроса. Доступ осуществляется по имени параметра.

Методы

Количество / Count

Синтаксис: Количество()

Возвращает: тип: Число. Количество параметров.

Описание: Получить количество параметров в запросе.

Получить / Get

Синтаксис: Получить(Параметр)

Параметры:

  • Параметр - тип: Число, Строка. Индекс или имя параметра.

Возвращает: тип: любой. Значение параметра.

Описание: Получить значение параметра по индексу или имени.

Индекс / IndexOf

Синтаксис: Индекс(Имя)

Параметры:

  • Имя - тип: Строка. Имя параметра.

Возвращает: тип: Число. Индекс параметра.

Описание: Получить индекс параметра по имени, если параметр с таким именем не определен, то возвращается -1.

Установить / Set

Синтаксис: Установить(Имя, Значение)

Параметры:

  • Имя - тип: Число, Строка. Индекс или имя параметра.
  • Значение - тип: любой. Значение параметра.

Описание: Устанавливает значение параметра.

ПоставщикДанныхТЗ / VTProvider

Поставщик данных для табличного поля. Позволяет отобразить данные таблицы значений в табличном поле.

Свойство ТекущаяСтрока табличного поля имеет тип Число - номер строки таблицы значенией начиная с 1.

Свойства

ТаблицаЗначений / ValueTable

Доступ: чтение и запись

Тип: ТаблицаЗначений

Описание: Устанавливает таблицу значений. Она будет использоваться, как источник данных для отображения в табличном поле.

Методы

УстТаблицуЗначений / SetValueTable

Синтаксис: УстТаблицуЗначений(ТаблицаЗначений)

Параметры:

  • ТаблицаЗначений - тип: ТаблицаЗначений. Объект таблицы значений для отображения.

Описание: Устанавливает таблицу значений. Она будет использоваться, как источник данных для отображения в табличном поле.

ПоставщикДанныхИТ / VTExtProvider

Поставщик данных для табличного поля. Позволяет отобразить данные индексированной таблицы в табличном поле.

Свойство ТекущаяСтрока табличного поля имеет тип Число - номер строки индексированной таблицы, начиная с 1.

Свойства

ИндексированнаяТаблица / IndexedTable

Доступ: чтение и запись

Тип: ИндексированнаяТаблица

Описание: Устанавливает индексированную таблицу. Она будет использоваться, как источник данных для отображения в табличном поле.

Индекс / Index

Доступ: чтение и запись

Тип: Строка, Число

Описание: Устанавливает индекс индексироанной таблицы, в соответствии с которым данные будут отображаться в табличном поле.

Объекты общего назначения

1cpp.Клавиатура / 1cpp.Keyboard

Свойства

<ИмяВиртуальнойКлавиши>

Доступ: Чтение.

Тип: Число.

Описание: Значение кода виртуальной клавиши.

Примеры доступа к кодам виртуальных клавиш:
  • Клавиатура.VK_SHIFT
  • Клавиатура.VK_CONTROL
  • Клавиатура.VK_ESCAPE
  • Клавиатура.VK_UP
  • Клавиатура.VK_DOWN

С полным списком имен виртуальных клавиш можно ознакомится в MSDN. Например тут http://msdn.microsoft.com/en-us/library/ms645540.aspx или тут http://msdn.microsoft.com/en-us/library/ms927178.aspx

Методы

ПолучитьСостояниеКлавиши / GetKeyState

Синтаксис: ПолучитьСостояниеКлавиши(ВиртКод, [ВклРежим])

Параметры:
  • ВиртКод - тип: Число. Код виртуальной клавиши.
  • ВклРежим - тип: Число. Выходной параметр. Необязательный. Имеет смысл для переключаемых клавиш таких как CAPS LOCK. 1 - клавиша включена (toggled), 0 - клавиша выключена (untoggled).

Возвращает: тип: Число. Текущее состояние клавиши: 1-нажата, 0-не нажата.

Описание: Определяет состояние любой клавиши.

ПолучитьИмяКлавиши / GetKeyNameText

Синтаксис: ПолучитьИмяКлавиши(Данные, [Режим])

Параметры:
  • Данные - тип: Число. Значение, в двоичном коде которого: биты 16-23 - сканкод, 24-флаг расширенной клавиатуры. В качестве значения можно передавать параметр <Данные> клавиатурных событий таких как ПриНажатииКлавиши().
  • Режим - тип: Число. 1 - включает режим безразличия к расположению клавиши на клавиатуре. Например левый или правый CTRL и SHIFT. Необязательный. Значение по-умолчанию 0.

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

Описание: Формирует представление имени клавиши.

Представление имени может зависеть от текущей локали.

Шрифт

Объект для определения шрифта текста.

Свойства

Вид / Type

Доступ: только чтение.

Тип: Число.

Описание: Вид шпифта.

  • 0 - специальное значение объекта типа шрифт, которое означает, что шрифт выбирается автоматически;
  • 1 - абсолютный, шрифт задан именем шрифта, размером и прочими признаками;
  • 2 - OEMFixedFont;
  • 3 - ANSIFixedFont;
  • 4 - ANSIVariableFont;
  • 5 - SystemFont;
  • 6 - DefaultGUIFont.

Имя / Name

Доступ: только чтение.

Тип: Строка.

Описание: Имя шрифта. (Имя гарнитуры)

Размер / Size

Доступ: только чтение.

Тип: Число.

Описание: Размер шрифта в пунктах.

Жирный / Bold

Доступ: только чтение.

Тип: Число.

Описание: Признак жирности шрифта. 0 - нормальный; 1 - жирный.

Наклонный / Italic

Доступ: только чтение.

Тип: Число.

Описание: Признак наклона шрифта. 0 - нормальный; 1 - наклонный.

Подчеркивание / Underline

Доступ: только чтение.

Тип: Число.

Описание: Признак подчеркивания шрифта. 0 - нормальный; 1 - подчеркнутый.

Зачеркивание / StrikeOut

Доступ: только чтение.

Тип: Число.

Описание: Признак зачеркивания шрифта. 0 - нормальный; 1 - зачеркнутый.

Конструкторы (Создание через фабрику объектов)

Основной

Синтаксис: Шрифт(Имя, Размер, Жирный, Наклонный, Подчеркивание, Зачеркивание)

Параметры:

  • Имя - тип Строка. Имя шрифта;
  • Размер - тип: Число. Размер в пунктах;
  • Жирный - тип: Число. Признак жирности шрифта. 0 - нормальный; 1 - жирный;
  • Наклонный - тип: Число. Признак наклона шрифта. 0 - нормальный; 1 - наклонный;
  • Подчеркивание - тип: Число. Признак подчеркивания шрифта. 0 - нормальный; 1 - подчеркнутый;
  • Зачеркивание - тип: Число. Признак зачеркивания шрифта. 0 - нормальный; 1 - зачеркнутый.

Описание: Создается абсолютный шрифт.

Системный

Синтаксис: Шрифт(Вид)

Параметры:

  • Вид - тип Число. Вид шрифта. Допустимо указывать любой, кроме значения "абсолютный". Необязательный, по умолчанию 0.

Описание: Создается системный шрифт.

На основании другого шрифта

Синтаксис: Шрифт(Шрифт, Имя, Размер, Жирный, Наклонный, Подчеркивание, Зачеркивание)

Параметры:

  • Шрифт - тип Шрифт. Шрифт, на основании которого будет построен новый объект типа шрифт;
  • Имя - тип Строка. Имя шрифта;
  • Размер - тип: Число. Размер в пунктах;
  • Жирный - тип: Число. Признак жирности шрифта. 0 - нормальный; 1 - жирный;
  • Наклонный - тип: Число. Признак наклона шрифта. 0 - нормальный; 1 - наклонный;
  • Подчеркивание - тип: Число. Признак подчеркивания шрифта. 0 - нормальный; 1 - подчеркнутый;
  • Зачеркивание - тип: Число. Признак зачеркивания шрифта. 0 - нормальный; 1 - зачеркнутый.

Описание: Создается шрифт на основании другого шрифта. Все параметры кроме первого - необязательны, и если не указано, то этот показатель шрифта не изменяется.

ФабрикаОбъектов

Специальный объект, представляющий из себя сборник конструкторов встроенных классов. Позволяет снабдить процесс создания объектов параметрами. Каждый метод фабрики объектов возвращает объект одноименного типа.

Описание синтаксиса создания расположено в описании самих объектов.

Например:

глФабрика = СоздатьОбъект("ФабрикаОбъектов");
ШрифтАриал10Жирный = глФабрика.Шрифт("Arial", 10, 1);
Generated on: 2013-01-30 23:09 UTC. Generated by Docutils from reStructuredText source.