• Post category:API
  • Запись изменена:15.12.2023

new Api()

Базовый класс

Методы

Название Описание
AddComment Добавляет комментарий к нужному элементу или массиву Runs.
attachEvent Подписывается на указанное событие и вызывает функцию обратного вызова при возникновении события.
ConvertDocument Преобразует документ в Markdown или HTML текст.
CreateBlipFill Создает заливку при применении к объекту, используя выбранное изображение в качестве фона объекта.
CreateBlockLvlSdt Создает новый контейнер блочного уровня.
CreateBullet Создает маркер для абзаца со знаком или символом, указанным в параметре sSymbol.
CreateChart Создает график с заданными параметрами.
CreateGradientStop Создает диаграмму с указанными параметрами
CreateHyperlink Создает новый текстовый блок гиперссылки для вставки в текущий абзац или таблицу.
CreateImage Создает изображение с указанными параметрами.
CreateInlineLvlSdt Создает новый инлайн-контейнер.
CreateLinearGradientFill Создает линейную градиентную заливку для применения к объекту, используя выбранный линейный градиент в качестве фона объекта.
CreateNoFill Создает отсутствие заливки и удаляет заливку из элемента.
CreateNumbering Создает маркер для абзаца со знаком или символом нумерации, указанным в параметре sType.
CreateOleObject Создает объект OLE с указанными параметрами.
CreateParagraph Создает новый абзац.
CreatePatternFill Создает заливку узором для применения к объекту, используя выбранный узор в качестве фона объекта.
CreatePresetColor Создает цвет, выбирая его из одного из доступных наборов цветов.
CreateRadialGradientFill Создает радиальную градиентную заливку для применения к объекту, используя выбранный радиальный градиент в качестве фона объекта.
CreateRange Создает диапазон элемента. Если не указать начальную и конечную позиции, диапазон будет взят из всего элемента.
CreateRGBColor Создает цвет RGB, устанавливая соответствующие значения для красного, зеленого и синего компонентов цвета.
CreateRun Создает новый текстовый блок меньшего размера для вставки в текущий абзац или таблицу.
CreateSchemeColor Создает сложную цветовую схему, выбирая одну из доступных схем.
CreateShape Создает фигуру с заданными параметрами.
CreateSolidFill Создает сплошную заливку для применения к объекту, используя выбранный сплошной цвет в качестве фона объекта.
CreateStroke Создает обводку, добавляя тени к элементу.
CreateTable Создает новую таблицу с указанным количеством строк и столбцов.
CreateTextPr Создает пустые свойства текста.
CreateWordArt Создает объект Text Art с указанными параметрами.
detachEvent Отписывается от указанного события.
FromJSON Преобразует указанный объект JSON в объект Документ Конструктора соответствующего типа.
GetDocument Возвращает основной документ.
GetMailMergeReceptionsCount Возвращает количество приемов слияния почты.
GetMailMergeTemplateDocContent Возвращает документ шаблона слияния.
LoadMailMergeData Загружает данные для объединения писем.
MailMerge Запускает процесс объединения писем.
ReplaceDocumentContent Заменяет содержимое основного документа другим содержимым документа.
ReplaceTextSmart Заменяет каждый абзац (или текст в ячейке) при выборе соответствующим текстом из массива строк.
Save Сохраняет изменения в указанном документе.

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oRun = Api.CreateRun();
oRun.AddText("This is an example for base class methods.");
oParagraph.AddElement(oRun);
oRun = Api.CreateRun();
oRun.AddText(" A paragraph and a numbered list were created.");
oParagraph.AddElement(oRun);
oRun = Api.CreateRun();
oRun.AddText(" Then a chart, a shape and a table were created. The result was saved to the document.");
oParagraph.AddElement(oRun);
oParagraph = Api.CreateParagraph();
var oDrawing = Api.CreateChart("bar3D", [
  [200, 240, 280],
  [250, 260, 280]
], ["Projected Revenue", "Estimated Costs"], [2014, 2015, 2016], 4051300, 2347595, 24);
oParagraph.AddDrawing(oDrawing);
oDocument.Push(oParagraph);
oParagraph = Api.CreateParagraph();
var oGs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 224, 204), 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 164, 101), 100000);
var oFill = Api.CreateLinearGradientFill([oGs1, oGs2], 5400000);
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
oDrawing = Api.CreateShape("rect", 5930900, 395605, oFill, oStroke);
oParagraph.AddDrawing(oDrawing);
oDocument.Push(oParagraph);
var oTableStyle = oDocument.CreateStyle("CustomTableStyle", "table");
oTableStyle.SetBasedOn(oDocument.GetStyle("Bordered - Accent 5"));
var oTable = Api.CreateTable(3, 3);
oTable.SetWidth("percent", 100);
oTable.SetStyle(oTableStyle);
oDocument.Push(oTable);
Api.Save();
builder.SaveFile("docx", "Api.docx");
builder.CloseFile();