Get Started
Usage API
More information

ApiDocument

new ApiDocument()

Class representing a document.

Methods

Name Description
AddComment

Adds a comment to the document.

AddElement

Adds a paragraph or a table or a blockLvl content control using its position in the document content.

CreateNewHistoryPoint

Creates a new history point.

CreateNumbering

Creates an abstract multilevel numbering with a specified type.

CreateSection

Creates a new document section which ends at the specified paragraph. Allows to set local parameters to the current section - page size, footer, header, columns, etc.

CreateStyle

Creates a new style with the specified type and name. If there is a style with the same name it will be replaced with a new one.

DeleteBookmark

Removes a bookmark from the document, if one exists.

GetAllCharts

Returns a collection of chart objects in the document.

GetAllContentControls

Returns a list of all the content controls in the document.

GetAllDrawingObjects

Returns a collection of drawing objects in the document.

GetAllImages

Returns a collection of image objects in the document.

GetAllShapes

Returns a collection of shape objects in the document.

GetAllTablesOnPage

Returns a collection of tables on a given absolute page. This method can be a little bit slow, because it runs the document calculation process to arrange tables on the specified page.

GetBookmarkRange

Returns a bookmark range.

GetClassType

Returns a type of the ApiDocument class.

GetCommentsReport

Returns a report about all the comments added to the document.

GetDefaultParaPr

Returns a set of default paragraph properties in the current document.

GetDefaultStyle

Returns the default style parameters for the specified document element.

GetDefaultTextPr

Returns a set of default properties for the text run in the current document.

GetElement

Returns an element by its position in the document.

GetElementsCount

Returns a number of elements in the current document.

GetFinalSection

Returns the document final section.

GetRange

Returns a Range object that represents the part of the document contained in the specified document.

GetRangeBySelect

Returns a range object by the current selection.

GetReviewReport

Returns a report about every change which was made to the document in the review mode.

GetSections

Returns a collection of section objects in the document.

GetStyle

Returns a style by its name.

InsertContent

Inserts an array of elements into the current position of the document.

InsertWatermark

Inserts a watermark on each document page.

IsTrackRevisions

Checks if change tracking mode is enabled or not.

Last

Returns the last document element.

Push

Pushes a paragraph or a table to actually add it to the document.

RemoveAllElements

Removes all the elements from the current document or from the current document element. When all elements are removed, a new empty paragraph is automatically created. If you want to add content to this paragraph, use the ApiDocumentContent.GetElement method.

RemoveElement

Removes an element using the position specified.

RemoveSelection

Removes the current selection.

Search

Searches for a scope of a document object. The search results are a collection of ApiRange objects.

SearchAndReplace

Finds and replaces the text.

SetEvenAndOddHdrFtr

Specifies whether sections in this document will have different headers and footers for even and odd pages (one header/footer for odd pages and another header/footer for even pages).

SetTrackRevisions

Sets the change tracking mode.

ToHtml

Converts a document to HTML.

ToMarkdown

Converts a document to Markdown.

Example

Copy code
builder.CreateFile("docx");
oDocument = Api.GetDocument();
oNoSpacingStyle = oDocument.GetStyle("No Spacing");
oSection = oDocument.GetFinalSection();
oHeader = oSection.GetHeader("default", true);
oParagraph = oHeader.GetElement(0);
oParagraph.AddText("This is the text in the default header");
oTextPr = oDocument.GetDefaultTextPr();
oTextPr.SetFontSize(22);
oTextPr.SetLanguage("en-US");
oTextPr.SetFontFamily("Calibri");
oParaPr = oDocument.GetDefaultParaPr();
oParaPr.SetSpacingLine(276, "auto");
oParaPr.SetSpacingAfter(200);
oNormalStyle = oDocument.GetDefaultStyle("paragraph");
oParaPr = oNormalStyle.GetParaPr();
oParaPr.SetSpacingLine(240, "auto");
oParaPr.SetJc("both");
oTextPr = oNormalStyle.GetTextPr();
oTextPr.SetColor(0x26, 0x26, 0x26, false);
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();
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);
oNumbering = oDocument.CreateNumbering("bullet");
for (nLvl = 0; nLvl < 8; ++nLvl) {
  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();

Resulting document