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

Delete

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

Copy

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

AddText

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