new ApiRun()

Класс, представляющий небольшой текстовый блок под названием «запуск».

Методы

Название Описание
AddColumnBreak Добавляет разрыв колонки к текущей позиции выполнения и начинает следующий элемент с новой колонки.
AddDrawing Добавляет объект рисования (изображение, фигуру или диаграмму) к текущему текстовому прогону.
AddHyperlink Добавляет гиперссылку к текущему запуску.
AddLineBreak Добавляет разрыв строки к текущей позиции выполнения и начинает следующий элемент с новой строки.
AddPageBreak Добавляет разрыв страницы и начинает следующий элемент с новой страницы.
AddTabStop Добавляет ограничение табуляции к текущему запуску.
AddText Добавляет некоторый текст к текущему выполнению.
ClearContent Очищает содержимое текущего запуска.
Copy Создает копию текущего запуска.
Delete Удаляет текущий запуск.
GetClassType Возвращает тип класса ApiRun.
GetFontNames Возвращает все имена шрифтов из всех элементов внутри текущего запуска.
GetParentContentControl Возвращает элемент управления содержимым, содержащий текущий запуск.
GetParentTable Возвращает таблицу, содержащую текущий прогон.
GetParentTableCell Возвращает ячейку таблицы, содержащую текущий прогон.
GetRange Возвращает объект диапазона, представляющий часть документа, содержащуюся в указанном запуске.
GetTextPr Возвращает свойства текста текущего запуска.
RemoveAllElements Удаляет все элементы из текущего запуска.
Select Выбирает текущий запуск.
SetBold Устанавливает свойство полужирного шрифта в текстовый символ.
SetCaps Указывает, что все символы нижнего регистра в текущем тексте форматируются для отображения только как эквиваленты символов заглавных букв.
SetColor Устанавливает цвет текста для текущей строки текста в формате RGB.
SetDoubleStrikeout Указывает, что содержимое текущего запуска отображается с двумя горизонтальными линиями через каждый символ, отображаемый в строке.
SetFill Устанавливает цвет текста в соответствии с текущим цветом текста.
SetFontFamily Устанавливает все 4 слота шрифтов с указанным семейством шрифтов.
SetFontSize Устанавливает размер шрифта для символов текущего текстового прогона.
SetHighlight Задает цвет выделения, который применяется в качестве фона к содержимому текущего запуска.
SetItalic Устанавливает свойство курсива на текстовый символ.
SetLanguage Указывает языки, которые будут использоваться для проверки орфографии и грамматики (если требуется) при обработке содержимого этого текстового прогона.
SetOutLine Устанавливает контур текста в текущий текстовый ряд.
SetPosition Определяет величину, на которую текст поднимается или опускается для этого прогона по отношению к базовой линии по умолчанию для окружающего непозиционированного текста.
SetShd Определяет затенение, применяемое к содержимому текущего текстового прогона.
SetSmallCaps Указывает, что все символы строчных букв в этом тексте форматируются для отображения только как эквиваленты символов заглавных букв, которые на два пункта меньше, чем фактический размер шрифта, указанный для этого текста.
SetSpacing Устанавливает расстояние между текстами, измеряемое в двадцатых долях пункта.
SetStrikeout Указывает, что содержимое текущего запуска отображается с одной горизонтальной линией, проходящей через центр строки.
SetStyle Устанавливает стиль для текущего запуска.
SetTextFill Устанавливает текстовую заливку для текущего запуска.
SetTextPr Задает свойства текста для текущего запуска.
SetUnderline Указывает, что содержимое текущего запуска отображается вместе со строкой, появляющейся непосредственно под символом (меньше, чем все интервалы над и под символами в строке).
AddComment Добавляет комментарий к текущему запуску.
SetVertAlign Указывает выравнивание, которое будет применяться к содержимому текущего прогона по отношению к внешнему виду текстового прогона по умолчанию:

  • «baseline» — символы текущего текста будут выровнены по базовой линии текста по умолчанию.
  • «subscript» — символы текущего текста будут выровнены ниже базовой линии текста по умолчанию.
  • «superscript» — символы текущего текста будут выровнены выше базовой линии текста по умолчанию.
ToJSON Преобразует объект ApiRun в объект JSON.
WrapInMailMergeField Обертывает прогон в поле почтовой рассылки.

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oRun = Api.CreateRun();
oRun.AddText("This is just a sample text.");
oRun.AddLineBreak();
oRun.AddTabStop();
oRun.AddTabStop();
oRun.AddText(" Nothing special.");
oRun.SetBold(true);
oParagraph.AddElement(oRun);
var oCopyRun = oRun.Copy();
oParagraph.AddLineBreak();
oParagraph.AddElement(oCopyRun);
oRun = Api.CreateRun();
var oDrawing = Api.CreateChart("bar3D", [
  [200, 240, 280],
  [250, 260, 280]
], ["Projected Revenue", "Estimated Costs"], [2014, 2015, 2016], 4051300, 2347595, 24);
oDrawing.SetVerAxisTitle("USD In Hundred Thousands", 10);
oDrawing.SetHorAxisTitle("Year", 11);
oDrawing.SetLegendPos("bottom");
oDrawing.SetShowDataLabels(false, false, true, false);
oDrawing.SetTitle("Financial Overview", 13);
oRun.AddDrawing(oDrawing);
oParagraph.AddElement(oRun);
oRun = Api.CreateRun();
oRun.AddText("R7");
oRun.SetCaps(true);
oParagraph.AddLineBreak();
oParagraph.AddElement(oRun);
oRun.AddHyperlink("/", "main page");
builder.SaveFile("docx", "ApiRun.docx");
builder.CloseFile();

ToJSON

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

SetStyle

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