Getting started
How it works?
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), ONLYOFFICE Document Builder allows to insert the content and format it to your liking quickly and easily.
ONLYOFFICE Document Builder is a C++ library used to create and edit Office Open XML format files (documents, spreadsheets and presentations) and save them to DOCX, XSLX, PPTX and PDF formats.
There are two ways to use ONLYOFFICE Document Builder in your own project:
Integrate this library into your own application. You can download ONLYOFFICE Document Builder here.
After you download and unpack the files, the library is ready for integration.
- Use the provided executive binary wrapper for an easy start. The latest versions of executable files can always be downloaded here. After the file download, run it and see the examples of how ONLYOFFICE Document Builder can be used without the need to write any application.
The Linux OS versions of
ONLYOFFICE Document Builder require the following dependencies to be installed:
Debian/Ubuntu:
sudo apt-get install libstdc++6 libcurl3-gnutls libc6 libxml2 libcurl3 fonts-dejavu fonts-opensymbol
sudo apt-get install fonts-liberation ttf-mscorefonts-installer fonts-crosextra-carlito
RedHat/CentOS:
sudo yum install glibc libcurl libxml2 dejavu-lgc-sans-fonts dejavu-lgc-sans-mono-fonts dejavu-lgc-serif-fonts dejavu-sans-fonts dejavu-sans-mono-fonts dejavu-serif-fonts libreoffice-opensymbol-fonts
To launch ONLYOFFICE Document Builder run the following command:
docbuilder mydocument.docbuilder
Here docbuilder is the name of ONLYOFFICE Document Builder (together with the path, if the command is run from the folder different from where the executive is placed) executive file (it will look like docbuilder.exe for Windows version, documentbuilder for Linux and Mac OS), and the mydocument.docbuilder parameter is the name (again, together with the path, if needed) of the script file that will form the document contents.
Read the Integration section for more information on how to integrate ONLYOFFICE Document Builder into your own application.
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:
Creating and editing tables
Using shapes, images and charts
Creating and editing forms
Learn how to create a new document
Learn how to edit an existing document
Learn how to create a paragraph
Learn how to edit the text in the existing paragraph
Learn how to change the paragraph properties (text documents)
Learn how to change the paragraph properties (spreadsheet)
Learn how to change the paragraph properties (presentations)
Learn how to edit the paragraph borders
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
Learn how to change the text font size
Learn how to make the text font italic
Learn how to make the text font bold
Learn how to make the text font strikeout
Learn how to make the text font double strikeout
Learn how to make the text font underlined
Learn how to change the text font color
Learn how to change the text font background color
Learn how to change the text font highlighting
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
Learn how to make the text font spacing
Learn how to create a table
Learn how to create a table with an existing style
Learn how to add a new row
Learn how to add a new column
Learn how to get a specific row
Learn how to get a specific cell
Learn how to add some text to the cell
Learn how to set the table width
Learn how to set the table borders
Learn how to set the table background
Learn how to set the table cell margins
Learn how to set borders to a single table cell
Learn how to set the background to a single table cell
Learn how to set width to the table column
Learn how to set the text direction in a table cell
Learn how to add a bulleted list
Learn how to add a numbered list
Learn how to add a page break
Learn how to get and edit a page header
Learn how to get and edit a page footer
Learn how to create a shape
Learn how to add text to the shape
Learn how to create a chart
Learn how to add an image to the document
Learn how to set the text language
Learn how to set the page size
Learn how to set the page margins
Learn how to create a form
Learn how to set the border color to the form
Learn how to set the placeholder text to the form
Learn how to set the text properties to the form
Learn how to clear the form
Learn how to get the tip text from the form
Learn how to get the text from the form
Learn how to make a form fixed size
Learn how to set the picture position inside the form
Learn how to set the radio group key to the checkbox
Learn how to set the list values to the combo box
Learn how to select the specified value from the combo box list values
Close
×