• Post category:ApiTable
  • Запись изменена:24.12.2023

new ApiTable()

Класс, представляющий таблицу.

Методы

Название Описание
AddColumn Добавляет новый столбец в текущую таблицу.
AddComment Добавляет комментарий ко всему содержимому текущей таблицы.
AddColumns Добавляет новые столбцы в текущую таблицу.
AddElement Добавляет абзац, таблицу или элемент управления содержимым blockLvl, используя его положение в ячейке.
AddRow Добавляет новую строку в текущую таблицу.
AddRows Добавляет новые строки в текущую таблицу.
Clear Очищает содержимое таблицы.
Copy Создает копию текущей таблицы.
Delete Удаляет текущую таблицу.
GetCell Возвращает ячейку по ее положению.
GetClassType Возвращает тип класса ApiTable.
GetNext Возвращает следующую таблицу, если она существует.
GetParentContentControl Возвращает элемент управления содержимым, содержащий текущую таблицу.
GetParentTable Возвращает таблицу, содержащую текущую таблицу.
GetParentTableCell Возвращает ячейку таблицы, содержащую текущую таблицу.
GetPosInParent Возвращает позицию таблицы в ее родительском элементе.
GetPrevious Возвращает предыдущую таблицу, если она существует.
GetRange Возвращает объект Range, который представляет часть документа, содержащуюся в указанной таблице.
GetRow Возвращает строку таблицы по ее положению в таблице.
GetRowsCount Возвращает количество строк в текущей таблице.
GetTableDescription Возвращает описание таблицы.
GetTables Возвращает таблицы, содержащие текущую таблицу.
GetTableTitle Возвращает заголовок таблицы (caption).
InsertInContentControl Обертывает текущий объект таблицы элементом управления содержимым.
MergeCells Объединяет массив ячеек. Если слияние выполнено успешно, оно вернет результирующую объединенную ячейку, в противном случае результат будет «нулевым». Количество ячеек в любой строке и количество строк в текущей таблице может быть изменено.
RemoveColumn Удаляет столбец таблицы с указанной ячейкой.
RemoveRow Удаляет строку таблицы с указанной ячейкой.
ReplaceByElement Заменяет текущую таблицу новым элементом.
Search Выполняет поиск области видимости объекта таблицы. Результатом поиска является коллекция объектов ApiRange.
Select Выбирает текущую таблицу.
SetBackgroundColor Устанавливает цвет фона для всех ячеек в текущей таблице.
SetCellSpacing Задает интервал между ячейками таблицы по умолчанию (расстояние между соседними ячейками и краями таблицы).
SetHAlign Устанавливает горизонтальное выравнивание таблицы.
SetJc Указывает выравнивание текущей таблицы относительно текстовых полей в текущем разделе.
SetPaddings Устанавливает отступы таблицы. Если таблица встроенная, то применяется только отступ слева.
SetShd Определяет затенение, которое применяется к экстентам текущей таблицы.
SetStyle Устанавливает стиль для текущей таблицы.
SetStyleColBandSize Указывает количество столбцов, которые будут содержать каждую полосу столбца таблицы для этого стиля таблицы.
SetStyleRowBandSize Указывает количество строк, которые будут составлять каждую полосу строк таблицы для данного стиля таблицы.
SetTableBorderBottom Устанавливает границу, которая будет отображаться внизу текущей таблицы.
SetTableBorderInsideH Указывает границу, которая будет отображаться на всех горизонтальных границах ячеек таблицы, которые не находятся на самом дальнем краю родительской таблицы (все горизонтальные границы, которые не являются самой верхней или самой нижней границей).
SetTableBorderInsideV Указывает границу, которая будет отображаться на всех вертикальных границах ячеек таблицы, которые не находятся на самом дальнем краю родительской таблицы (все вертикальные границы, которые не являются крайними левыми или крайними правыми границами).
SetTableBorderLeft Устанавливает границу, которая будет отображаться слева от текущей таблицы.
SetTableBorderRight Устанавливает границу, которая будет отображаться справо от текущей таблицы.
SetTableBorderTop Устанавливает границу, которая будет отображаться в верхней части текущей таблицы.
SetTableCellMarginBottom Задает расстояние, которое останется между нижней границей содержимого ячейки и границей всех ячеек таблицы в родительской таблице (или строке таблицы).
SetTableCellMarginLeft Задает расстояние, которое останется между левой границей содержимого ячейки и левой границей всех ячеек таблицы в родительской таблице (или строке таблицы).
SetTableCellMarginRight Задает расстояние, которое останется между правой границей содержимого ячейки и правой границей всех ячеек таблицы в родительской таблице (или строке таблицы).
SetTableCellMarginTop Задает расстояние, которое останется между верхней границей содержимого ячейки и верхней границей всех ячеек таблицы в родительской таблице (или строке таблицы).
SetTableDescription Устанавливает описание таблицы.
SetTableInd Указывает отступ, который будет добавлен перед передним краем текущей таблицы в документе (левый край в таблице слева направо и правый край в таблице справа налево).
SetTableLayout Указывает алгоритм, который будет использоваться для размещения содержимого текущей таблицы в документе.
SetTableLook Указывает компоненты условного форматирования ссылаемого стиля таблицы (если он существует), которые будут применены к набору строк таблицы с текущими исключениями свойств на уровне таблицы. Стиль таблицы может задавать до шести различных необязательных условных форматов, например, различное форматирование для первого столбца, которые затем можно применять или не применять к отдельным строкам таблицы в родительской таблице.

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

SetTableTitle Задает заголовок таблицы (caption).
SetTextPr Применяет настройки текста ко всему содержимому таблицы.
SetVAlign Задает вертикальное выравнивание таблицы.
SetWidth Устанавливает предпочтительную ширину для текущей таблицы. Таблицы создаются со свойствами метода ApiTable.SetWidth, установленными по умолчанию, которые всегда переопределяют свойства метода ApiTablePr.SetWidth. Вот почему нет смысла пытаться применить ApiTablePr.SetWidth . Вместо этого мы рекомендуем использовать метод ApiTablePr.SetWidth.
SetWrappingStyle Устанавливает стиль обертывания таблицы.
Split Разделяет ячейку на заданное количество строк и столбцов.
ToJSON Преобразует объект ApiTable в объект JSON.

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTable = Api.CreateTable(5, 5);
oTable.SetWidth("percent", 100);
oTable.AddColumn(oTable.GetRow(0).GetCell(1), true);
oTable.AddRow(oTable.GetRow(1).GetCell(0), true);
var oCopyTable = oTable.Copy();
var oTableStyle = oDocument.CreateStyle("CustomTableStyle", "table");
oTableStyle.SetBasedOn(oDocument.GetStyle("Bordered - Accent 5"));
oTable.SetStyle(oTableStyle);
var oParagraph = Api.CreateParagraph();
oParagraph.AddText("Merged cell");
var oCell = oTable.MergeCells([oTable.GetRow(1).GetCell(1), oTable.GetRow(1).GetCell(2), oTable.GetRow(2).GetCell(1), oTable.GetRow(2).GetCell(2)]);
oTable.AddElement(oCell, 0, oParagraph);
var oBlockLvlSdt = oTable.InsertInContentControl(1);
oDocument.AddElement(0, oBlockLvlSdt);
var sClassType = oTable.GetClassType();
oParagraph = oDocument.GetElement(0);
oParagraph.AddText("Class Type = " + sClassType);
var aSearch = oTable.Search("cell");
aSearch[0].SetBold(true);
oCopyTable.SetHAlign("center");
oCopyTable.SetTableBorderTop("single", 4, 0, 0, 0, 255);
oCopyTable.SetTableBorderBottom("single", 32, 0, 0, 0, 255);
oCopyTable.SetTableBorderLeft("single", 4, 0, 0, 0, 255);
oCopyTable.SetTableBorderRight("single", 4, 0, 0, 0, 255);
oCopyTable.SetTableBorderInsideV("single", 4, 0, 255, 0, 0);
oCopyTable.SetTableBorderInsideH("single", 4, 0, 255, 0, 0);
oDocument.Push(oCopyTable);
builder.SaveFile("docx", "ApiTable.docx");
builder.CloseFile();