new ApiDocument()

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

Методы

НазваниеОписание
AcceptAllRevisionChangesПринимает все изменения, сделанные в режиме просмотра.
AddCommentДобавляет комментарий к документу.
AddElementДобавляет абзац, таблицу или элемент управления содержимым blockLvl, используя его положение в содержимом документа.
AddEndnoteДобавляет примечание в конце к выделенному тексту (или к текущей позиции, если выделение не существует).
AddFootnoteДобавляет сноску для выделенного текста (или текущей позиции, если выделения не существует).
ClearAllFieldsОчищает все формы в документе.
CreateNewHistoryPointСоздает новую точку истории.
CreateNumberingСоздает абстрактную многоуровневую нумерацию с заданным типом.
CreateSectionСоздает новый раздел документа, который заканчивается на указанном абзаце. Позволяет установить локальные параметры для текущего раздела — размер страницы, колонтитул, верхний колонтитул, колонки и т.д.
CreateStyleСоздает новый стиль с указанным типом и именем. Если существует стиль с таким же именем, он будет заменен новым.
DeleteBookmarkУдаляет закладку из документа, если она существует.
GetAllBookmarksNamesВозвращает массив с именами всех закладок в текущем документе.
GetAllCaptionParagraphsReturns 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();