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 в объект Document Builder соответствующего типа.
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();

FromJSON

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

CreateRun

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