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