• Post category:ApiParagraph
  • Запись изменена:10.12.2023

new ApiParagraph()

Класс, представляющий параграф.

Методы

НазваниеОписание
AddBookmarkCrossRefДобавляет перекрестную ссылку на закладку к текущему абзацу. Абзац должен быть в документе.
AddCaptionCrossRefДобавляет перекрестную ссылку на заголовок к текущему абзацу. Абзац должен находиться в документе.
AddColumnBreakДобавляет разрыв столбца для текущей позиции и начинает следующий элемент с нового столбца.
AddCommentДобавляет комментарий к абзацу.
AddDrawingДобавляет объект рисования (изображение, фигуру или диаграмму) в текущий абзац.
AddElementДобавляет элемент к текущему абзацу.
AddEndnoteCrossRefДобавляет перекрестную ссылку концевой сноски к текущему абзацу. Абзац должен быть в документе.
AddFootnoteCrossRefДобавляет перекрестную ссылку в сноске к текущему пункту. Абзац должен быть в документе.
AddHeadingCrossRefДобавляет перекрестную ссылку заголовка к текущему абзацу. Абзац должен быть в документе.
AddHyperlinkДобавляет гиперссылку к абзацу.
AddInlineLvlSdtДобавляет встроенный контейнер.
AddLineBreakДобавляет разрыв строки в текущую позицию и начинает следующий элемент с новой строки.
AddNumberedCrossRefДобавляет пронумерованную перекрестную ссылку к текущему абзацу. Абзац должен находиться в документе.
AddPageBreakДобавляет разрыв страницы и запускает следующий элемент со следующей страницы.
AddPageNumberВставляет номер текущей страницы документа в абзац. Этот метод работает только для абзацев с верхним/нижним колонтитулом документа.
AddPagesCountВставляет несколько страниц текущего документа в абзац. Этот метод работает только для абзацев с верхним/нижним колонтитулом документа.
AddTabStopДобавляет позицию табуляции к текущему абзацу.
AddTextДобавляет текст в текущемий абзац.
CopyСоздает копию абзаца. Игнорируйте комментарии, сноски, сложные поля.
DeleteУдаляет текущий абзац.
GetAllChartsВозвращает коллекцию объектов диаграммы в параграфе.
GetAllContentControlsВозвращает коллекцию объектов управления содержимым в абзаце.
GetAllDrawingObjectsВозвращает коллекцию объектов рисования в абзаце.
GetAllImagesВозвращает коллекцию объектов изображений в параграфе.
GetAllOleObjectsВозвращает коллекцию объектов OLE в абзаце.
GetAllShapesВозвращает коллекцию объектов формы в абзаце.
GetClassTypeВозвращает тип класса ApiParagraph.
GetElementВозвращает элемент абзаца, используя указанную позицию.
GetElementsCountВозвращает количество элементов в текущем абзаце.
GetFontNamesВозвращает все названия шрифтов из всех элементов внутри текущего абзаца.
GetIndFirstLineВозвращает отступ первой строки абзаца.
GetIndLeftВозвращает левый боковой отступ абзаца.
GetIndRightВозвращает правый боковой отступ абзаца.
GetJcВозвращает обоснование содержимого параграфа.
GetLastRunWithTextВозвращает последний Run с текстом в текущем абзаце.
GetNextВозвращает следующий абзац.
GetNumberingВозвращает определение нумерации и уровень нумерации для нумерованного списка.
GetParagraphMarkTextPrВозвращает текстовые свойства метки абзаца, которая используется для обозначения конца абзаца. Метка может также приобретать обычные текстовые свойства, такие как жирный шрифт, курсив, подчеркивание и т.д.
GetParaPrВозвращает свойства абзаца.
GetParentContentControlВозвращает элемент управления содержимым, содержащий текущий абзац.
GetParentTableВозвращает таблицу, содержащую текущий абзац.
GetParentTableCellВозвращает ячейку таблицы, которая содержит текущий абзац.
GetPosInParentВозвращает позицию абзаца в его родительском элементе.
GetPreviousВозвращает предыдущий абзац.
GetRangeВозвращает объект Range, представляющий часть документа, содержащуюся в указанном абзаце.
GetShdВозвращает затенение, примененное к содержимому абзаца.
GetSpacingAfterВозвращает значение интервала после текущего абзаца.
GetSpacingBeforeВозвращает интервал перед значением текущего абзаца.
GetSpacingLineRuleВозвращает правило межстрочного интервала абзаца.
GetSpacingLineValueВозвращает значение межстрочного интервала абзаца.
GetStyleВозвращает метод стиля параграфа.
GetTextВозвращает текст абзаца.
GetTextPrВозвращает свойства текста в параграфе.
InsertInContentControlОбертывает объект абзаца элементом управления форматированным текстовым содержимым.
InsertParagraphВставляет абзац в указанную позицию.
LastВозвращает последний элемент абзаца, который не пуст.
PushДобавляет элемент в текущий абзац.
RemoveAllElementsУдаляет все элементы из текущего абзаца. Когда все элементы удаляются из абзаца, автоматически создается новый пустой ряд. Если вы хотите добавить содержимое в этот запуск, используйте метод ApiParagraph.GetElement.
RemoveElementУдаляет элемент, используя указанную позицию. Если удаляемый элемент является последним элементом абзаца (т. е. все элементы удаляются из абзаца), автоматически создается новый пустой ряд. Если вы хотите добавить содержимое в этот запуск, используйте метод ApiParagraph.GetElement.
ReplaceByElementЗаменяет текущий абзац новым элементом.
SearchИщет область объекта в абзаце. Результаты поиска представляют собой набор объектов ApiRange.
SelectВыбирает текущий абзац.
SetBetweenBorderОпределяет границу, которая будет отображаться между каждым абзацем в наборе абзацев, имеющих одинаковый набор настроек границы абзаца.
SetBoldУстанавливает свойство полужирного шрифта в текстовый символ.
SetBottomBorderУказывает границу, которая будет отображаться под набором абзацев с одинаковыми настройками границы абзаца. Абзацы одного стиля, идущие один за другим, рассматриваются как единый блок, поэтому граница добавляется ко всему блоку, а не к каждому абзацу в этом блоке.
SetBulletУстанавливает маркер или нумерацию для текущего абзаца.
SetCapsУказывает, что все строчные символы в этом абзаце форматируются для отображения только как эквиваленты заглавных букв.
SetColorУстанавливает цвет текста для текущего абзаца в формате RGB.
SetContextualSpacingУказывает, что любое пространство перед или после этого абзаца, установленное с помощью элемента ApiParaPr.SetSpacingBefore или ApiParaPr.SetSpacingAfter, не должно применяться, если предыдущий и последующий абзацы имеют одинаковый стиль абзаца, влияя на верхний и нижний интервал соответственно.
SetDoubleStrikeoutУказывает, что содержимое этого абзаца отображается с двумя горизонтальными линиями через каждый символ, отображаемый в строке.
SetFontFamilyУстанавливает все 4 шрифта slot с указанным семейством шрифтов.
SetFontSizeУстанавливает размер шрифта для символов текущего абзаца.
SetHighlightОпределяет цвет выделения, который применяется в качестве фона к содержимому текущего абзаца.
SetIndFirstLineУстанавливает отступ первой строки абзаца.
SetIndLeftУстанавливает отступ слева от абзаца.
SetIndRightУстанавливает отступ справа от абзаца.
SetItalicУстанавливает свойство курсива на текстовый символ.
SetJcУстанавливает выравнивание содержимого абзаца.
SetKeepLinesУказывает, что при отображении документа с использованием просмотра страницы все строки текущего абзаца по возможности сохраняются на одной странице.
SetKeepNextУказывает, что при отображении документа с использованием представления с разбивкой на страницы содержимое текущего абзаца, по возможности, хотя бы частично отображается на той же странице, что и следующий абзац.
SetLeftBorderОпределяет границу, которая будет отображаться в левой части страницы вокруг указанного абзаца.
SetNumberingУказывает, что текущий абзац ссылается на экземпляр определения нумерации в текущем документе.
SetNumPrУказывает, что текущий абзац ссылается на экземпляр определения нумерации в текущем документе.
SetPageBreakBeforeУказывает, что при отображении документа с использованием разбиения на страницы содержимое текущего абзаца отображается в начале новой страницы документа.
SetPositionУказывает величину, на которую текст увеличивается или уменьшается для этого абзаца по отношению к базовой линии по умолчанию для окружающего непозиционного текста.
SetRightBorderОпределяет границу, которая будет отображаться в правой части страницы вокруг указанного абзаца.
SetShdОпределяет затенение, применяемое к содержимому текущего абзаца.
SetSmallCapsУказывает, что все символы строчных букв в этом абзаце форматируются для отображения только как их эквиваленты символов заглавных букв, которые на два пункта меньше, чем фактический размер шрифта, указанный для этого текста.
SetSpacingУстанавливает расстояние между текстами, измеряемое в двадцатых долях.
SetSpacingAfterУстанавливает интервал после текущего абзаца. Если значение параметра isAfterAuto равно true, то любое значение параметра nAfter игнорируется. Если параметр isAfterAuto не указан, то он будет интерпретирован как false.
SetSpacingBeforeУстанавливает интервал перед текущим абзацем. Если значение параметра isBeforeAuto равно true, то любое значение параметра nBefore игнорируется. Если параметр isBeforeAuto не указан, то он будет интерпретирован как false.
SetSpacingLineУстанавливает межстрочный интервал абзаца. Если значение параметра sLineRule равно «atLeast» или «exact», то значение параметра nLine будет интерпретироваться как двадцатые доли точки. Если значение параметра sLineRule равно «auto», то значение параметра nLine будет интерпретироваться как 240 долей строки.
SetStrikeoutУказывает, что содержимое этого абзаца отображается одной горизонтальной линией, проходящей через центр строки.
SetStyleБазовый метод стиля абзаца. Этот метод не используется сам по себе, так как он только формирует основу для метода ApiParagraph.SetStyle, который задает выбранный или созданный стиль для абзаца.
SetTabsУказывает последовательность пользовательских позиций табуляции, которые будут использоваться для любых символов табуляции в текущем абзаце. Предупреждение: длины массива aPos и массива aVal ДОЛЖНЫ БЫТЬ равны друг другу.
SetTextPrЗадает свойства текста в абзаце.
SetTopBorderОпределяет границу, которая будет отображаться над набором абзацев, имеющих одинаковые настройки границ абзацев. Абзацы одного стиля, идущие один за другим, рассматриваются как один блок, поэтому граница добавляется ко всему блоку, а не к каждому абзацу в этом блоке.
SetUnderlineУказывает, что содержимое этого абзаца отображается вместе со строкой, расположенной непосредственно под символом (меньше, чем все интервалы над и под символами в строке).
SetVertAlignЗадает выравнивание, которое будет применено к содержимому этого абзаца по отношению к внешнему виду текста абзаца по умолчанию:

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

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("This is a paragraph with the text in it aligned by the left side. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes.");
oParagraph.SetJc("left");
oParagraph = Api.CreateParagraph();
oParagraph.AddText("This is a paragraph with the text in it aligned by the right side. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes.");
oParagraph.SetJc("right");
oDocument.Push(oParagraph);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("This is a paragraph with the text in it aligned by the center. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes.");
oParagraph.SetJc("center");
oDocument.Push(oParagraph);
oParagraph = Api.CreateParagraph();
oParagraph.AddText("This is a paragraph with the text in it aligned by both sides (justified). ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes. ");
oParagraph.AddText("These sentences are used to add lines for demonstrative purposes.");
oParagraph.SetJc("both");
oDocument.Push(oParagraph);
builder.SaveFile("docx", "ApiParagraph.docx");
builder.CloseFile();