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();

Split

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