Get Started

Builder.API

Builder.Framework

Builder.App

Builder.Server

More information

Changelog

Overview

As any document is a composite object consisting of a tree of larger nodes (paragraphs and tables) where it is possible to insert smaller document elements (text runs, images, charts, shapes), Builder.API allows to insert the content and format it to your liking quickly and easily.

Builder.API is the JavaScript library which is used to work with the document editor. It contains classes and methods for every document type: Text document API, Spreadsheet API, Presentation API, and Form API.

Where to use

Here are some examples of where you can use Builder.API:

build plugins using Builder.API in the plugin code .js file to interact with the editor content and web services;
write macros using the JavaScript syntax and Builder.API scripting notation;
generate documents using Builder.API in the Document Builder scripts.

Where to start

If you are not sure where to start, you can use the list of most common tasks below to find where to go and start creating your document:

Basic document actions

Main paragraph actions

Modifying fonts

Creating and editing tables

Working with lists

Columns

add columns

Page breaks

add a page break

Headers and footers

Using shapes, images and charts

Text language

set the text language

Page size and margins

Creating and editing forms

Learn how to create a new document

Learn how to edit an existing document

Learn how to create a paragraph

Create a paragraph (text documents) — Api.CreateParagraph
Create a paragraph (spreadsheets) — Api.CreateParagraph
Create a paragraph (presentations) — Api.CreateParagraph
Push the created paragraph (text documents) — ApiDocument.Push
Push the created paragraph (spreadsheets) — ApiDocumentContent.Push
Push the created paragraph (presentations) — ApiDocumentContent.Push

Learn how to edit the text in the existing paragraph

Get paragraph in document (text documents) — ApiDocument.GetElement
Get paragraph in document (spreadsheets) — ApiDocumentContent.GetElement
Get paragraph in document (presentations) — ApiDocumentContent.GetElement

Learn how to change the paragraph properties (text documents)

Set text alignment in paragraph — ApiParagraph.SetJc
Set first line indentation — ApiParagraph.SetIndFirstLine
Set paragraph left side indentation — ApiParagraph.SetIndLeft
Set paragraph right side indentation — ApiParagraph.SetIndRight
Set paragraph spacing — ApiParagraph.SetSpacingBefore/SetSpacingAfter
Set paragraph background — ApiParagraph.SetShd

Learn how to change the paragraph properties (spreadsheet)

Set text alignment in paragraph — ApiParagraph.SetJc
Set first line indentation — ApiParagraph.SetIndFirstLine
Set paragraph left side indentation — ApiParagraph.SetIndLeft
Set paragraph right side indentation — ApiParagraph.SetIndRight
Set paragraph spacing — ApiParagraph.SetSpacingBefore/SetSpacingAfter

Learn how to change the paragraph properties (presentations)

Set text alignment in paragraph — ApiParagraph.SetJc
Set first line indentation — ApiParagraph.SetIndFirstLine
Set paragraph left side indentation — ApiParagraph.SetIndLeft
Set paragraph right side indentation — ApiParagraph.SetIndRight
Set paragraph spacing — ApiParagraph.SetSpacingBefore/SetSpacingAfter

Learn how to edit the paragraph borders

Set paragraph between borders — ApiParagraph.SetBetweenBorder
Set top border — ApiParagraph.SetTopBorder
Set bottom border — ApiParagraph.SetBottomBorder
Set right border — ApiParagraph.SetRightBorder
Set left border — ApiParagraph.SetLeftBorder

Learn how to create a paragraph with an existing style

Create a paragraph with a style (text documents) — ApiParaPr
Create a paragraph with a style (spreadsheets) — ApiParaPr
Create a paragraph with a style (presentations) — ApiParaPr

Learn how to change the text font family

Set font family for part of text or single word (text documents) — ApiRun.SetFontFamily
Set font family for part of text or single word (spreadsheets) — ApiRun.SetFontFamily
Set font family for part of text or single word (presentations) — ApiRun.SetFontFamily
Set font family for whole text (text documents) — ApiTextPr.SetFontFamily
Set font family for whole text (spreadsheets) — ApiTextPr.SetFontFamily
Set font family for whole text (presentations) — ApiTextPr.SetFontFamily

Learn how to change the text font size

Set font size for part of text or single word (text documents) — ApiRun.SetFontSize
Set font size for part of text or single word (spreadsheets) — ApiRun.SetFontSize
Set font size for part of text or single word (presentations) — ApiRun.SetFontSize
Set font size for whole text (text documents) — ApiTextPr.SetFontSize
Set font size for whole text (spreadsheets) — ApiTextPr.SetFontSize
Set font size for whole text (presentations) — ApiTextPr.SetFontSize

Learn how to make the text font italic

Make font italic for part of text or single word (text documents) — ApiRun.SetItalic
Make font italic for part of text or single word (spreadsheets) — ApiRun.SetItalic
Make font italic for part of text or single word (presentations) — ApiRun.SetItalic
Make font italic for whole text (text documents) — ApiTextPr.SetItalic
Make font italic for whole text (spreadsheets) — ApiTextPr.SetItalic
Make font italic for whole text (presentations) — ApiTextPr.SetItalic

Learn how to make the text font bold

Make font bold for part of text or single word (text documents) — ApiRun.SetBold
Make font bold for part of text or single word (spreadsheets) — ApiRun.SetBold
Make font bold for part of text or single word (presentations) — ApiRun.SetBold
Make font bold for whole text (text documents) — ApiTextPr.SetBold
Make font bold for whole text (spreadsheets) — ApiTextPr.SetBold
Make font bold for whole text (presentations) — ApiTextPr.SetBold

Learn how to make the text font strikeout

Make font strikeout for part of text or single word (text documents) — ApiRun.SetStrikeout
Make font strikeout for part of text or single word (spreadsheets) — ApiRun.SetStrikeout
Make font strikeout for part of text or single word (presentations) — ApiRun.SetStrikeout
Make font strikeout for whole text (text documents) — ApiTextPr.SetStrikeout
Make font strikeout for whole text (spreadsheets) — ApiTextPr.SetStrikeout
Make font strikeout for whole text (presentations) — ApiTextPr.SetStrikeout

Learn how to make the text font double strikeout

Make font double strikeout for part of text or single word (text documents) — ApiRun.SetDoubleStrikeout
Make font double strikeout for part of text or single word (spreadsheets) — ApiRun.SetDoubleStrikeout
Make font double strikeout for part of text or single word (presentations) — ApiRun.SetDoubleStrikeout
Make font double strikeout for whole text (text documents) — ApiTextPr.SetDoubleStrikeout
Make font double strikeout for whole text (spreadsheets) — ApiTextPr.SetDoubleStrikeout
Make font double strikeout for whole text (presentations) — ApiTextPr.SetDoubleStrikeout

Learn how to make the text font underlined

Make font underlined for part of text or single word (text documents) — ApiRun.SetUnderline
Make font underlined for part of text or single word (spreadsheets) — ApiRun.SetUnderline
Make font underlined for part of text or single word (presentations) — ApiRun.SetUnderline
Make font underlined for whole text (text documents) — ApiTextPr.SetUnderline
Make font underlined for whole text (spreadsheets) — ApiTextPr.SetUnderline
Make font underlined for whole text (presentations) — ApiTextPr.SetUnderline

Learn how to change the text font color

Set font color for part of text or single word (text documents) — ApiRun.SetColor
Set font color for part of text or single word (spreadsheets) — ApiRun.SetFill
Set font color for part of text or single word (presentations) — ApiRun.SetFill
Set font color for whole text (text documents) — ApiTextPr.SetColor
Set font color for whole text (spreadsheets) — ApiTextPr.SetFill
Set font color for whole text (presentations) — ApiTextPr.SetFill

Learn how to change the text font background color

Set font background color for part of text or single word — ApiRun.SetShd
Set font background color for whole text — ApiTextPr.SetShd

Learn how to change the text font highlighting

Set font highlighting for part of text or single word (text documents) — ApiRun.SetHighlight
Set font highlighting for part of text or single word (spreadsheets) — ApiRun.SetHighlight
Set font highlighting for part of text or single word (presentations) — ApiRun.SetHighlight
Set font highlighting for whole text (text documents) — ApiTextPr.SetHighlight

Learn how to make the text font capitalized

Make font capitalized for part of text or single word (text documents) — ApiRun.SetCaps
Make font capitalized for part of text or single word (spreadsheets) — ApiRun.SetCaps
Make font capitalized for part of text or single word (presentations) — ApiRun.SetCaps
Make font capitalized for whole text (text documents) — ApiTextPr.SetCaps
Make font capitalized for whole text (spreadsheets) — ApiTextPr.SetCaps
Make font capitalized for whole text (presentations) — ApiTextPr.SetCaps

Learn how to make the text font small capitalized

Make font small capitalized for part of text or single word (text documents) — ApiRun.SetSmallCaps
Make font small capitalized for part of text or single word (spreadsheets) — ApiRun.SetSmallCaps
Make font small capitalized for part of text or single word (presentations) — ApiRun.SetSmallCaps
Make font small capitalized for whole text (text documents) — ApiTextPr.SetSmallCaps
Make font small capitalized for whole text (spreadsheets) — ApiTextPr.SetSmallCaps
Make font small capitalized for whole text (presentations) — ApiTextPr.SetSmallCaps

Learn how to make the text font spacing

Set font spacing for part of text or single word (text documents) — ApiRun.SetSpacing
Set font spacing for part of text or single word (spreadsheets) — ApiRun.SetSpacing
Set font spacing for part of text or single word (presentations) — ApiRun.SetSpacing
Set font spacing for whole text (text documents) — ApiTextPr.SetSpacing
Set font spacing for whole text (spreadsheets) — ApiTextPr.SetSpacing
Set font spacing for whole text (presentations) — ApiTextPr.SetSpacing

Learn how to create a table

Create a table — Api.CreateTable
Push the created table — ApiDocument.Push

Learn how to create a table with an existing style

Create table with existing style — ApiTable.SetStyle
Create table and base style on existing one — ApiStyle.SetBasedOn

Learn how to add a new row

Add a new row — ApiTable.AddRow

Learn how to add a new column

Add a new column — ApiTable.AddColumn

Learn how to get a specific row

Get a specific existing/created row — ApiTable.GetRow

Learn how to get a specific cell

Get a specific existing cell — ApiTableRow.GetCell

Learn how to add some text to the cell

Add text to table cell — ApiTableCell.GetContent

Learn how to set the table width

Set table width — ApiTable.SetWidth

Learn how to set the table borders

Set table top border — ApiTable.SetTableBorderTop
Set table bottom border — ApiTable.SetTableBorderBottom
Set table right border — ApiTable.SetTableBorderRight
Set table left border — ApiTable.SetTableBorderLeft
Set table inside horizontal border — ApiTable.SetTableBorderInsideH
Set table inside vertical border — ApiTable.SetTableBorderInsideV

Learn how to set the table background

Set table background — ApiTable.SetShd

Learn how to set the table cell margins

Set table cell top margin — ApiTable.SetTableCellMarginTop
Set table cell bottom margin — ApiTable.SetTableCellMarginBottom
Set table cell right margin — ApiTable.SetTableCellMarginRight
Set table cell left margin — ApiTable.SetTableCellMarginLeft

Learn how to set borders to a single table cell

Set table cell top border — ApiTableCell.SetCellBorderTop
Set table cell bottom border — ApiTableCell.SetCellBorderBottom
Set table cell right border — ApiTableCell.SetCellBorderRight
Set table cell left border — ApiTableCell.SetCellBorderLeft

Learn how to set the background to a single table cell

Set table cell background — ApiTableCell.SetShd

Learn how to set width to the table column

Set table column width — ApiTableCell.SetWidth

Learn how to set the text direction in a table cell

Set table cell text direction — ApiTableCell.SetTextDirection

Learn how to add a bulleted list

Create bulleted list (text documents) — ApiDocument.CreateNumbering
Create bulleted list (spreadsheets) — ApiParagraph.SetBullet
Create bulleted list (presentations) — ApiParagraph.SetBullet
Set and edit list levels — ApiNumbering/ApiNumberingLevel

Learn how to add a numbered list

Create numbered list — ApiDocument.CreateNumbering
Set and edit list levels — ApiNumbering/ApiNumberingLevel

Learn how to create a shape

Create a shape (text documents) — Api.CreateShape
Create a shape (spreadsheets) — ApiWorksheet.AddShape
Create a shape (presentations) — Api.CreateShape

Learn how to add text to the shape

Get shape content to add text (text documents) — ApiShape.GetDocContent
Get shape content to add text (spreadsheets) — ApiShape.GetDocContent
Get shape content to add text (presentations) — ApiShape.GetDocContent
Position text in shape vertically (text documents) — ApiShape.SetVerticalTextAlign
Position text in shape vertically (spreadsheets) — ApiShape.SetVerticalTextAlign
Position text in shape vertically (presentations) — ApiShape.SetVerticalTextAlign
Set the text paddings to the shape (text documents) — ApiShape.SetPaddings
Set the text paddings to the shape (spreadsheets) — ApiShape.SetPaddings

Learn how to create a chart

Create chart (text documents) — Api.CreateChart
Create chart (spreadsheets) — ApiWorksheet.AddChart
Create chart (presentations) — Api.CreateChart
Setup chart and set its parameters (text documents) — ApiChart
Setup chart and set its parameters (spreadsheets) — ApiChart
Setup chart and set its parameters (presentations) — ApiChart

Learn how to add an image to the document

Create image (text documents) — Api.CreateImage
Create image (spreadsheets) — ApiWorksheet.AddImage
Create image (presentations) — Api.CreateImage

Learn how to set the text language

Set language for part of text or single word (text documents) — ApiRun.SetLanguage
Set language for part of text or single word (spreadsheets) — ApiRun.SetLanguage
Set language for part of text or single word (presentations) — ApiRun.SetLanguage
Set language for whole text — ApiTextPr.SetLanguage

Learn how to set the page size

Set page size — ApiSection.SetPageSize

Learn how to set the page margins

Set page margins — ApiSection.SetPageMargins

Learn how to create a form

Create a text form — Api.CreateTextForm
Create a combo box form — Api.CreateComboBoxForm
Create a checkbox form — Api.CreateCheckBoxForm
Create a picture form — Api.CreatePictureForm

Learn how to set the border color to the form

Set the border color to the text form — ApiTextForm.SetBorderColor
Set the border color to the combo box form — ApiComboBoxForm.SetBorderColor
Set the border color to the checkbox form — ApiCheckBoxForm.SetBorderColor
Set the border color to the picture form — ApiPictureForm.SetBorderColor

Learn how to set the placeholder text to the form

Set the placeholder text to the text form — ApiTextForm.SetPlaceholderText
Set the placeholder text to the combo box form — ApiComboBoxForm.SetPlaceholderText
Set the placeholder text to the checkbox form — ApiCheckBoxForm.SetPlaceholderText
Set the placeholder text to the picture form — ApiPictureForm.SetPlaceholderText

Learn how to set the text properties to the form

Set the text properties to the text form — ApiTextForm.SetTextPr
Set the text properties to the combo box form — ApiComboBoxForm.SetTextPr
Set the text properties to the checkbox form — ApiCheckBoxForm.SetTextPr
Set the text properties to the picture form — ApiPictureForm.SetTextPr

Learn how to clear the form

Clear the text form — ApiTextForm.Clear
Clear the combo box form — ApiComboBoxForm.Clear
Clear the checkbox form — ApiCheckBoxForm.Clear
Clear the picture form — ApiPictureForm.Clear

Learn how to get the tip text from the form

Get the tip text from the text form — ApiTextForm.GetTipText
Get the tip text from the combo box form — ApiComboBoxForm.GetTipText
Get the tip text from the checkbox form — ApiCheckBoxForm.GetTipText
Get the tip text from the picture form — ApiPictureForm.GetTipText

Learn how to get the text from the form

Get the text from the text form — ApiTextForm.GetText
Get the text from the combo box form — ApiComboBoxForm.GetText

Learn how to make a form fixed size

Make a text form fixed size — ApiTextForm.ToFixed
Make a combo box form fixed size — ApiComboBoxForm.ToFixed
Make a checkbox form fixed size — ApiCheckBoxForm.ToFixed
Make a picture form fixed size — ApiPictureForm.ToFixed

Learn how to set the picture position inside the form

Set the picture position inside the form — ApiPictureForm.SetPicturePosition

Learn how to set the radio group key to the checkbox

Set the radio group key to the checkbox — ApiCheckBoxForm.SetRadioGroup

Learn how to set the list values to the combo box

Set the list values to the combo box — ApiComboBoxForm.SetListValues

Learn how to select the specified value from the combo box list values

Select the specified value from the combo box list values — ApiComboBoxForm.SelectListValue