• Post category:ApiDocument
  • Запись изменена:09.12.2023

new ApiDocument()

Класс, представляющий собой документ.

Методы

Название Описание
AcceptAllRevisionChanges Принимает все изменения, сделанные в режиме просмотра.
AddComment Добавляет комментарий к документу.
AddElement Добавляет абзац, таблицу или элемент управления содержимым blockLvl, используя его положение в содержимом документа.
AddEndnote Добавляет примечание в конце к выделенному тексту (или к текущей позиции, если выделение не существует).
AddFootnote Добавляет сноску для выделенного текста (или текущей позиции, если выделения не существует).
ClearAllFields Очищает все формы в документе.
CreateNewHistoryPoint Создает новую точку истории.
CreateNumbering Создает абстрактную многоуровневую нумерацию с заданным типом.
CreateSection Создает новый раздел документа, который заканчивается на указанном абзаце. Позволяет установить локальные параметры для текущего раздела — размер страницы, колонтитул, верхний колонтитул, колонки и т.д.
CreateStyle Создает новый стиль с указанным типом и именем. Если существует стиль с таким же именем, он будет заменен новым.
DeleteBookmark Удаляет закладку из документа, если она существует.
GetAllBookmarksNames Возвращает массив с именами всех закладок в текущем документе.
GetAllCaptionParagraphs Returns all caption paragraphs of the specified type from the current document.
GetAllCharts Возвращает коллекцию объектов диаграммы из содержимого документа.
GetAllContentControls Возвращает список всех элементов управления содержимым из документа.
GetAllDrawingObjects Возвращает коллекцию объектов рисования из содержимого документа.
GetAllForms Возвращает все существующие формы в документе.
GetAllHeadingParagraphs Возвращает все абзацы заголовков из текущего документа.
GetAllImages Возвращает коллекцию объектов изображения из содержимого документа.
GetAllNumberedParagraphs Возвращает все пронумерованные абзацы из текущего документа.
GetAllOleObjects Возвращает коллекцию OLE-объектов из содержимого документа.
GetAllShapes Возвращает коллекцию объектов диаграммы из содержимого документа.
GetAllTablesOnPage Возвращает коллекцию таблиц на заданной абсолютной странице. Этот метод может быть немного медленным, поскольку он запускает процесс вычисления документа, чтобы расположить таблицы на заданной странице.
GetAllStyles Возвращает все стили текущего документа.
GetBookmarkRange Возвращает диапазон закладок.
GetClassType Возвращает набор свойств абзаца по умолчанию в текущем документе.
GetCommentsReport Возвращает отчет обо всех комментариях, добавленных к документу.
GetContent Возвращает массив элементов документа из текущего объекта ApiDocumentContent.
GetContentControlsByTag Возвращает список всех элементов управления содержимым в документе с указанным именем тега.
GetDefaultParaPr Возвращает набор свойств абзаца по умолчанию в текущем документе.
GetDefaultStyle Возвращает параметры стиля по умолчанию для указанного элемента документа.
GetDefaultTextPr Возвращает набор свойств по умолчанию для текста, выполняемого в текущем документе.
GetElement Возвращает элемент по его позиции в документе.
GetElementsCount Возвращает количество элементов в текущем документе.
GetEndNotesFirstParagraphs Возвращает первые абзацы из всех сносок в текущем документе.
GetFinalSection Возвращает конечную секцию документа.
GetFootnotesFirstParagraphs Возвращает первые абзацы из всех сносок в текущем документе.
GetFormsByTag Возвращает список всех форм в документе с указанным именем тега.
GetRange Возвращает объект Range, который представляет часть документа, содержащуюся в указанном документе.
GetRangeBySelect Возвращает объект диапазона по текущему выделению.
GetReviewReport Возвращает отчет обо всех изменениях, внесенных в документ в режиме просмотра.
GetSections Возвращает коллекцию объектов раздела в документе.
GetSelectedDrawings Возвращает все выбранные рисунки в текущем документе.
GetStyle Возвращает стиль по его названию.
GetTagsOfAllContentControls Возвращает список всех тегов, которые используются для всех элементов управления содержимым в документе.
GetTagsOfAllForms Возвращает список всех тегов, которые используются для всех форм в документе.
InsertContent Вставляет массив элементов в текущую позицию документа.
InsertWatermark Вставляет водяной знак на каждую страницу документа.
IsTrackRevisions Проверяет, включен или нет режим отслеживания изменений.
Last Возвращает последний элемент документа.
Push Перемещает абзац или таблицу, чтобы фактически добавить их в документ.
RejectAllRevisionChanges Отклоняет все изменения, сделанные в режиме обзора.
RemoveAllElements Удаляет все элементы из текущего документа или из текущего элемента документа. При удалении всех элементов автоматически создается новый пустой абзац. Если вы хотите добавить содержимое в этот абзац, используйте метод ApiDocumentContent.GetElement.
RemoveElement Удаляет элемент, используя указанную позицию.
RemoveSelection Удаляет текущий выбор.
ReplaceCurrentImage Заменяет текущее изображение на заданное изображение.
ReplaceDrawing Заменяет рисунок новым рисунком.
Search Выполняет поиск области видимости объекта документа. Результатом поиска является коллекция объектов ApiRange.
SearchAndReplace Находит и заменяет текст.
SetEvenAndOddHdrFtr Указывает, будут ли разделы в этом документе иметь разные верхние и нижние колонтитулы для четных и нечетных страниц (один верхний/нижний колонтитул для нечетных страниц и другой верхний/нижний колонтитул для четных страниц).
SetFormsHighlight Устанавливает подсветку для форм в документе.
SetTrackRevisions Устанавливает режим отслеживания изменений.
ToHtml Преобразование документа в HTML.
ToJSON Преобразует объект ApiDocument в объект JSON.
ToMarkdown Преобразует документ в Markdown.
UpdateAllTOC Обновляет все оглавления в текущем документе.
UpdateAllTOF Обновляет все таблицы со значениями в текущем документе.

Пример

builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oNoSpacingStyle = oDocument.GetStyle("No Spacing");
var oSection = oDocument.GetFinalSection();
var oHeader = oSection.GetHeader("default", true);
var oParagraph = oHeader.GetElement(0);
oParagraph.AddText("This is the text in the default header");
var oTextPr = oDocument.GetDefaultTextPr();
oTextPr.SetFontSize(22);
oTextPr.SetLanguage("en-US");
oTextPr.SetFontFamily("Calibri");
var oParaPr = oDocument.GetDefaultParaPr();
oParaPr.SetSpacingLine(276, "auto");
oParaPr.SetSpacingAfter(200);
var oNormalStyle = oDocument.GetDefaultStyle("paragraph");
oParaPr = oNormalStyle.GetParaPr();
oParaPr.SetSpacingLine(240, "auto");
oParaPr.SetJc("both");
oTextPr = oNormalStyle.GetTextPr();
oTextPr.SetColor(0x26, 0x26, 0x26, false);
var oHeading1Style = oDocument.CreateStyle("Heading 1", "paragraph");
oParaPr = oHeading1Style.GetParaPr();
oParaPr.SetKeepNext(true);
oParaPr.SetKeepLines(true);
oParaPr.SetSpacingAfter(240);
oTextPr = oHeading1Style.GetTextPr();
oTextPr.SetColor(0xff, 0x68, 0x00, false);
oTextPr.SetFontSize(40);
oTextPr.SetFontFamily("Calibri Light");
oParagraph = oDocument.GetElement(0);
oParagraph.SetStyle(oHeading1Style);
oParagraph.AddText("This is a heading");
oParagraph = Api.CreateParagraph();
var oRun = Api.CreateRun();
oRun.AddText("Number of paragraph elements at this point: ");
oRun.AddTabStop();
oRun.AddText("" + oParagraph.GetElementsCount());
oRun.AddLineBreak();
oParagraph.AddElement(oRun);
oRun.AddText("Number of paragraph elements after we added a text run: ");
oRun.AddTabStop();
oRun.AddText("" + oParagraph.GetElementsCount());
oDocument.Push(oParagraph);
var oNumbering = oDocument.CreateNumbering("bullet");
for (let nLvl = 0; nLvl < 8; ++nLvl) {
  var oNumLvl = oNumbering.GetLevel(nLvl);
  oParagraph = Api.CreateParagraph();
  oParagraph.AddText("Default bullet lvl " + (nLvl + 1));
  oParagraph.SetNumbering(oNumLvl);
  oParagraph.SetContextualSpacing(true);
  oDocument.Push(oParagraph);
}
builder.SaveFile("docx", "ApiDocument.docx");
builder.CloseFile();