Get Started
Documentation

Using .docbuilder file

Structure used for .docbuilder file

All .docbuilder files have simple structure which allows to create them easily. They consist of the following main parts each of them having the appropriate CDocBuilder class method used:

  1. Preparing to work with the document (either the CDocBuilder.CreateFile or CDocBuilder.OpenFile methods are used together with the CDocBuilder.SetTmpFolder method).
    builder.SetTmpFolder("D:/DocBuilderTemp");
    builder.CreateFile("docx");
  2. Creating the document contents with the help of the CDocBuilder.ExecuteCommand method (the method is not used explicitly, the commands themselves are used instead).
    var oDocument = Api.GetDocument();
    var oParagraph;
    oParagraph = Api.CreateParagraph();
    oParagraph.SetJc("center");
    oParagraph.AddText("Center");
    oDocument.Push(oParagraph);
  3. Saving the document (using the CDocBuilder.SaveFile method) and releasing it to finish work with it (the CloseFile method).
    builder.SaveFile("pdf", "D:/TESTFILES/images.pdf");
    builder.CloseFile();

Rules for .docbuilder file

There are a few rules used for .docbuilder script file creation for them to work correctly:

  • The file encoding is always UTF8.
  • All the commands containing builder. are line separated, i.e. you cannot write them in one line, each command must start with its own line.
  • The comments are allowed. Any line starting with # or // is considered to be a comment.
  • Empty lines are allowed. You can enter any number of empty lines to separate the blocks, the parser will ignore them.
  • All the CDocBuilder methods (except the CDocBuilder.ExecuteCommand) are started with builder.
  • The CDocBuilder.ExecuteCommand method is not used explicitly, the command itself is used instead. This is done to avoid the parsing complexity and allow the use of common JavaScript commands and methods.
  • The CDocBuilder.RunTextA, CDocBuilder.RunTextW, CDocBuilder.Initialize and CDocBuilder.Dispose methods are not used in .docbuilder files.
  • All the methods in .docbuilder file (except the ones listed above) are used the same way as in C++ code. See the list of the methods below to find more on each of them.

Thus the example of the complete working .docbuilder file is available below.

Example

builder.SetTmpFolder("D:/DocBuilderTemp");
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oParagraph;
oParagraph = oDocument.GetElement(0);
oParagraph.SetJc("center");
oParagraph.AddText("Center");
builder.SaveFile("pdf", "D:/TESTFILES/images.pdf");
builder.CloseFile();