Перейти к основному содержимому

ОбластьТабличногоДокумента

Стд::ТабличныйДокумент::ОбластьТабличногоДокумента Доступность: Сервер

Область служит логическим объединение ячеек табличного документа. Одна и та же ячейка может входить во множество областей.

Сравнение ссылочное.

Иерархия типа

Базовые типы: Объект


Свойства

Верх

Доступность: Сервер ТолькоЧтение

Верх: Число

Номер первой сроки области

Начинается с единицы


ВесПриРастягиванииПоГоризонтали

Доступность: Сервер

ВесПриРастягиванииПоГоризонтали: Число

Весовой коэффициент для автоматического расчета ширины колонки при растягивании по горизонтали.


ВидЗаполнения

Доступность: Сервер ТолькоЧтение

Вид заполнения области табличного документа.

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


ГраницаСверху

Доступность: Сервер

Описывает границу области сверху.

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


ГраницаСлева

Доступность: Сервер

Описывает границу области слева.

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


ГраницаСнизу

Доступность: Сервер

Описывает границу области снизу.

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


ГраницаСправа

Доступность: Сервер

Описывает границу области справа.

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


Имя

Доступность: Сервер

Имя: Строка

Имя области.


Конец

Доступность: Сервер ТолькоЧтение

Конец: Число

Номер последней колонки области

Начинается с единицы


Начало

Доступность: Сервер ТолькоЧтение

Начало: Число

Номер первой колонки области

Начинается с единицы


Низ

Доступность: Сервер ТолькоЧтение

Низ: Число

Номер последней строки области

Начинается с единицы


ОтступСверху

Доступность: Сервер

ОтступСверху: Число

Отступ от верхней границы ячейки. В пунктах (1/72 дюйма).

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


ОтступСлева

Доступность: Сервер

ОтступСлева: Число

Отступ от левой границы ячейки. В пунктах (1/72 дюйма).

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


ОтступСнизу

Доступность: Сервер

ОтступСнизу: Число

Отступ от нижней границы ячейки. В пунктах (1/72 дюйма).

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


ОтступСправа

Доступность: Сервер

ОтступСправа: Число

Отступ от правой границы ячейки. В пунктах (1/72 дюйма).

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


РастягиватьПоГоризонтали

Доступность: Сервер

РастягиватьПоГоризонтали: Булево

Признак того, что ширина колонки рассчитывается автоматически в зависимости от размера отображаемой области ячейки.


Методы

ВВыводимуюОбласть

Доступность: Сервер

Возвращает выводимую область табличного документа, созданную на основании текущей области. Изменения в созданной области не затронут текущую область.


ВНовыйТабличныйДокумент

Доступность: Сервер

ВНовыйТабличныйДокумент(): ТабличныйДокумент
Создает новый табличный документ из области.


ВСтроку

Доступность: Сервер

ВСтроку(): Строка
Переопределение: ВСтроку

Имя области.


Обвести

Доступность: Сервер

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

  • ГраницаСлева - Задает границу слева. Если параметр не указан, граница слева не рисуется.
  • ГраницаСверху - Задает границу сверху. Если параметр не указан, граница сверху не рисуется.
  • ГраницаСправа - Задает границу справа. Если параметр не указан, граница справа не рисуется.
  • ГраницаСнизу - Задает границу снизу. Если параметр не указан, граница снизу не рисуется.
метод ОбвестиОбластьШтампа(ОбластьШтампа: ОбластьТабличногоДокумента)
знч ГраницаРамки = новый ГраницаЯчейкиТабличногоДокумента(ВидГраницыЯчейкиТабличногоДокумента.Двойная, 1)
ОбластьШтампа.Обвести(ГраницаРамки, ГраницаРамки, ГраницаРамки, ГраницаРамки)
;

ОбъединитьЯчейки

Доступность: Сервер

ОбъединитьЯчейки()
Объединяет ячейки области


ПолучитьВыравниваниеПоВертикали

Доступность: Сервер

ПолучитьВыравниваниеПоВертикали(): ВыравниваниеПоВертикалиТабличногоДокумента
Возвращает выравнивание по вертикали (по высоте).


ПолучитьВыравниваниеПоГоризонтали

Доступность: Сервер

ПолучитьВыравниваниеПоГоризонтали(): ВыравниваниеПоГоризонталиТабличногоДокумента
Возвращает выравнивание текста по горизонтали (по ширине).


ПолучитьВысотуСтроки

Доступность: Сервер

ПолучитьВысотуСтроки(): Число?
Возвращает высоту строки в области (в пунктах) или Неопределено (высота строки будет рассчитываться автоматически).


ПолучитьИзображение

Доступность: Сервер

ПолучитьИзображение(): Байты?
Возвращает байты изображения, установленной для области. Если область состоит из нескольких ячеек, то возвращает картинку для первой из них.


ПолучитьИменаПараметровИШаблонов

Доступность: Сервер

ПолучитьИменаПараметровИШаблонов(): ЧитаемыйМассив<Строка>
Возвращает имена параметров и шаблонов, используемых в ячейках области табличного документа.

Примеры

метод ПолучитьИменаПараметровЭЦП(Область: ОбластьТабличногоДокумента)
знч ИменаПараметров = Область.ПолучитьИменаПараметровИШаблонов()
знч Результат = новый Массив<Строка>
для ИмяПараметра Из ИменаПараметров
если ИмяПараметра.НачинаетсяС("ЭПЦ_")
Результат.Добавить(ИмяПараметра)
;
;

возврат Результат
;

ПолучитьИмяПараметра

Доступность: Сервер

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


ПолучитьМаксимальнуюВысотуСтроки

Доступность: Сервер

ПолучитьМаксимальнуюВысотуСтроки(): Число?
Возвращает максимальную высоту строки в области (в пунктах). Возвращаемое значение Неопределено означает, что максимальная высота строки не ограничена.


ПолучитьОриентациюТекста

Доступность: Сервер

ПолучитьОриентациюТекста(): Число
Возвращает угол, установленный для области. Если область состоит из нескольких ячеек, то возвращает угол для первой из них.


ПолучитьПереносТекста

Доступность: Сервер

ПолучитьПереносТекста(): ПереносТекстаТабличногоДокумента?
Возвращает перенос текста в ячейках области.

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


ПолучитьТекст

Доступность: Сервер

ПолучитьТекст(): Строка
Получает текст из области. Если область состоит из нескольких ячеек, то возвращает текст первой из них.


ПолучитьУзор

Доступность: Сервер

Возвращает узор в ячейках области.

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


ПолучитьФорматСтрок

Доступность: Сервер

ПолучитьФорматСтрок(): ФорматСтрокТабличногоДокумента?
Возвращает формат строк, который используется в области ячеек. Будет возвращено Неопределено, если в области ячеек находится несколько форматов строк. Полученный формат строк можно назначить другим строкам областей табличного документа.


ПолучитьЦветРамки

Доступность: Сервер

ПолучитьЦветРамки(): Цвет?
Возвращает цвет рамки в ячейках области. Если ячеек больше одной, то возвращает цвет для первой из них.

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


ПолучитьЦветТекста

Доступность: Сервер

ПолучитьЦветТекста(): Цвет?
Возвращает цвет текста в ячейках области. Если ячеек больше одной, то возвращает цвет первой из них.

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


ПолучитьЦветУзора

Доступность: Сервер

ПолучитьЦветУзора(): Цвет?
Возвращает цвет узора в ячейках области. Если ячеек больше одной, то возвращает цвет первой из них.

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


ПолучитьЦветФона

Доступность: Сервер

ПолучитьЦветФона(): Цвет?
Возвращает цвет фона в ячейках области. Если ячеек больше одной, то возвращает цвет первой из них.

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


ПолучитьШиринуКолонки

Доступность: Сервер

ПолучитьШиринуКолонки(): Число
Возвращает ширину колонки в области ячеек (в так называемых средних символах шрифта).


ПолучитьШрифт

Доступность: Сервер

Возвращает шрифт, установленный для области.

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


РазъединитьЯчейки

Доступность: Сервер

РазъединитьЯчейки()
Разъединяет ячейки области


СоздатьНовыйФорматСтрок

Доступность: Сервер

СоздатьНовыйФорматСтрок()
Создает у области ячеек новый формат строк. В новом формате строк размеры колонок будут соответствовать размерам колонок, которые были установлены в области.

Разные форматы строк:

знч ТабличныйДокумент = новый ТабличныйДокумент()
знч ОбластьСтрок = ТабличныйДокумент.ПолучитьСтроки(2, 4)
ОбластьСтрок.СоздатьФорматСтрок()
// В строке #1 ширина колонки #1 останется прежней, т.к. форматы строк теперь разные
ТабличныйДокумент.ПолучитьОбласть(2, 1, 2, 1).УстановитьШиринуКолонки(50)

Общий формат строк:

знч ТабличныйДокумент = новый ТабличныйДокумент()
знч ОбластьСтрок = ТабличныйДокумент.ПолучитьСтроки(1, 2)
ОбластьСтрок.СоздатьФорматСтрок()
ТабличныйДокумент.ПолучитьОбласть(2, 1, 2, 1).УстановитьШиринуКолонки(50)

// Ширина колонки тоже 50
знч ШиринаКолонки = ТабличныйДокумент
.ПолучитьОбласть(1, 1, 1, 1)
.ПолучитьШиринуКолонки()

УстановитьВыравниваниеПоВертикали

Доступность: Сервер

УстановитьВыравниваниеПоВертикали(Выравнивание: ВыравниваниеПоВертикалиТабличногоДокумента)
Устанавливает выравнивание по вертикали (по высоте).

Область.УстановитьВыравниваниеПоГоризонтали(ВыравниваниеПоВертикалиТабличногоДокумента.Верх)

УстановитьВыравниваниеПоГоризонтали

Доступность: Сервер

УстановитьВыравниваниеПоГоризонтали(Выравнивание: ВыравниваниеПоГоризонталиТабличногоДокумента)
Устанавливает выравнивание текста по горизонтали (по ширине).

Область.УстановитьВыравниваниеПоГоризонтали(ВыравниваниеПоГоризонталиТабличногоДокумента.Центр)

УстановитьВысотуСтроки

Доступность: Сервер

УстановитьВысотуСтроки(Высота: Число?)
Устанавливает высоту строки в области ячеек (в пунктах). Если Высота имеет значение Неопределено, то высота строки будет рассчитываться автоматически. Допустимо использовать положительные целые или дробные числа. При установке высоты, максимальная высота строки будет рассчитываться автоматически (равна Неопределено).

Допустимо:

Область.УстановитьВысотуСтроки(1.25)

или

Область.УстановитьВысотуСтроки(50)

Исключения

ИсключениеНедопустимыйАргумент - при Высота меньше нуля.


УстановитьИзображение

Доступность: Сервер

УстановитьИзображение(
Изображение: Байты?,
ПрозрачныйФон: Булево = Ложь)
Устанавливает изображение в ячейки области.

Поддерживаются изображения следующих форматов:

  • BMP
  • EMF
  • GIF
  • Icon
  • JPEG
  • PNG
  • SVG
  • TIFF
  • WMF

УстановитьИмяПараметра

Доступность: Сервер

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


УстановитьМаксимальнуюВысотуСтроки

Доступность: Сервер

УстановитьМаксимальнуюВысотуСтроки(Высота: Число?)
Устанавливает максимальную высоту строки в области ячеек (в пунктах). Если Высота имеет значение Неопределено, то максимальная высота строки не ограничена. Допустимо использовать положительные целые или дробные числа. При установке максимальной высоты, высота строки будет рассчитываться автоматически (равна Неопределено).

Допустимо:

Область.УстановитьМаксимальнуюВысотуСтроки(1.25)

или

Область.УстановитьМаксимальнуюВысотуСтроки(50)

Исключения

ИсключениеНедопустимыйАргумент - при Высота меньше нуля.


УстановитьОриентациюТекста

Доступность: Сервер

УстановитьОриентациюТекста(Угол: Число)
Устанавливает угол ориентации текста.

Если ячеек больше одной, то в каждую будет выставлен одинаковый угол.


УстановитьПереносТекста

Доступность: Сервер

УстановитьПереносТекста(ПереносТекста: ПереносТекстаТабличногоДокумента)
Устанавливает размещение (перенос) текста в ячейках области.

Область.УстановитьПереносТекста(ПереносТекстаТабличногоДокумента.Переносить)

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

Доступность: Сервер

УстановитьТекст(
Текст: Строка,
Шаблон: Булево = Ложь)
Устанавливает текст в ячейки области. Если признак шаблона Истина, то при выводе ячейки нужно будет передать шаблонные параметры. Шаблонные параметры в макете табличного документа выделяются квадратными скобками.

Если ячеек больше одной, то в каждую будет выставлен одинаковый текст.

Примеры

пер Макет = ПолучитьМакетТабличногоДокумента()

пер ЗаголовокШапка = Макет.ПолучитьОбласть("R1C1:R1C3")
если ЗаголовокШапка.ВидЗаполнения == ВидЗаполненияОбластиТабличногоДокумента.Текст
ЗаголовокШапка .УстановитьТекст(Шапка.Текст + " от [ДатаФормирования]", Истина)
;

УстановитьУзор

Доступность: Сервер

УстановитьУзор(Узор: УзорТабличногоДокумента)
Устанавливает узор в ячейках области.

Если ячеек больше одной, то в каждую будет установлен одинаковый узор.

Исключения

ИсключениеНедопустимыйАргумент - Если будет указано значение НеизвестныйУзор.


УстановитьФорматСтрок

Доступность: Сервер

УстановитьФорматСтрок(ФорматСтрок: ФорматСтрокТабличногоДокумента)
Устанавливает ФорматСтрок формат строк для строк области ячеек. Строки могут ссылаться на один и тот же формат строк и при изменении ширины колонок одной из строк области, будет меняться ширина колонок других строк с тем же самым форматом строк.

метод СкопироватьФорматСтрок(ТабличныйДокумент: ТабличныйДокумент, НомерСтрокиОбразца: Число, НомерСтрокиНазначения Число)
знч ОбластьОбразец = ТабличныйДокумент.ПолучитьСтроки(НомерСтрокиОбразца, НомерСтрокиОбразца)
знч ФорматСтрок = ОбластьОбразец.ПолучитьФорматСтрок()
знч ОбластьНазначения = абличныйДокумент.ПолучитьСтроки(НомерСтрокиНазначения, НомерСтрокиНазначения)
ОбластьНазначения.УстановитьФорматСтрок(ФорматСтрок)
;

УстановитьЦветРамки

Доступность: Сервер

УстановитьЦветРамки(Цвет: Цвет)
Устанавливает цвет рамки в ячейках области.

Если ячеек больше одной, то в каждую будет выставлен одинаковый цвет.

  • Цвет - Цвет рамки.

Исключения

ИсключениеНедопустимыйАргумент - если будет передан НЕ абсолютный цвет.


УстановитьЦветРамкиПоУмолчанию

Доступность: Сервер

УстановитьЦветРамкиПоУмолчанию()
Устанавливает в каждую ячейку области цвет рамки по умолчанию.


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

Доступность: Сервер

УстановитьЦветТекста(Цвет: Цвет)
Устанавливает цвет текста в ячейках области. Если ячеек больше одной, то в каждую будет выставлен одинаковый цвет.

  • Цвет - Цвет текста.

Исключения

ИсключениеНедопустимыйАргумент - Если будет передан НЕ абсолютный цвет.


УстановитьЦветТекстаПоУмолчанию

Доступность: Сервер

УстановитьЦветТекстаПоУмолчанию()
Устанавливает в каждую ячейку области цвет текста по умолчанию.


УстановитьЦветУзора

Доступность: Сервер

УстановитьЦветУзора(Цвет: Цвет)
Устанавливает цвет узора в ячейках области. Если ячеек больше одной, то в каждую будет выставлен одинаковый цвет.

  • Цвет - Цвет узора.

Исключения

ИсключениеНедопустимыйАргумент - Если будет передан НЕ абсолютный цвет.


УстановитьЦветУзораПоУмолчанию

Доступность: Сервер

УстановитьЦветУзораПоУмолчанию()
Устанавливает в каждую ячейку области цвет узора по умолчанию.


УстановитьЦветФона

Доступность: Сервер

УстановитьЦветФона(Цвет: Цвет)
Устанавливает цвет фона в ячейках области. Если ячеек больше одной, то в каждую будет выставлен одинаковый цвет.

  • Цвет - Цвет фона.

Исключения

ИсключениеНедопустимыйАргумент - Если будет передан НЕ абсолютный цвет.


УстановитьЦветФонаПоУмолчанию

Доступность: Сервер

УстановитьЦветФонаПоУмолчанию()
Устанавливает в каждую ячейку области цвет фона по умолчанию.


УстановитьШиринуКолонки

Доступность: Сервер

УстановитьШиринуКолонки(Ширина: Число)
Устанавливает ширину колонки в области ячеек (в так называемых средних символах шрифта). Ширина принимает любые целые или дробные числа.

Область.УстановитьШиринуКолонки(50)

или

Область.УстановитьШиринуКолонки(1.25)

УстановитьШиринуКолонкиПоУмолчанию

Доступность: Сервер

УстановитьШиринуКолонкиПоУмолчанию()
Устанавливает ширину колонки по умолчанию.


УстановитьШрифт

Доступность: Сервер

УстановитьШрифт(Шрифт: ШрифтОбластиТабличногоДокумента)
Устанавливает шрифт в ячейках области.

Если ячеек больше одной, то в каждую будет выставлен одинаковый шрифт


УстановитьШрифтПоУмолчанию

Доступность: Сервер

УстановитьШрифтПоУмолчанию()
Устанавливает в каждую ячейку области шрифт по умолчанию.


Список унаследованных методов

Объект

ПолучитьТип, Представление