Document builder features

Opening or creating a document

In document builder mode, you can perform actions on an existing, already open document, or a new blank document.

You can create an empty document, to which you add pages. To create a docbuilder file, the viewer must be in document builder mode and you must either set the filename parameter to 'about:blank', or you must call the JavaScript API method openFile(String filename, int page) with openFile('about:blank', 0).

If the viewer is not in the document builder mode, the viewer acts as if no document is open. If you do not provide the filename parameter in document builder mode, it means that no document is open, rather than a new document being open.

When you add pages to an empty documents, a new document can be built, but you cannot switch to annotation or redaction mode.

If a document that is opened in document builder mode has security restrictions that preclude user modification, then the commit process fails. You can know whether a document can be built or not by opening the document and calling the following JavaScript API method:

ViewONE.isDocumentBuildable()

This call returns a Boolean value which indicates whether the document is able to be modified in Document Builder Mode. For more information about the commit process, see Building the document.

Page selection

When the Thumbnails view is visible, you can select pages and perform different types of actions on these pages.

Single selection

When you select a single page by clicking on the thumbnail or viewing the page in the main view, you can apply actions to the current selected page, such as actions cutting, copying, and rotating. If you add or paste a page, the new page is inserted after the current selected page.

Multi-selection

When the Thumbnails view is present, you can select multiple pages at the same time:

• Hold SHIFT and select a thumbnail to select all pages between the originally selected page and the newly selected page.
• Hold CTRL and select a thumbnail to add the newly selected page to the current selection.

When you have selected multiple pages at the same time, actions such as cut, copy, or rotate apply to all the pages selected. When you add or paste a page, it is inserted after the last selected page in the range.

Caret Selection

In the previous cases, inserting a page (by adding or pasting) occurs after the current or last selected page in a selection. To insert a page before the currently selected page, you can use caret selection. When the Thumbnails view is in a vertical alignment, you can select a caret by clicking the space above the current thumbnail. The current thumbnail is still the same page as you can view in the main view, but a horizontal pipe is displayed between the current and previous thumbnail. This indicates that when you insert a page, it is inserted between those two pages.

When a caret is selected all other options other than insertion are disabled.

Selection by using JavaScript

You can use the JavaScript API setPageSelection method to create a page selection without using the user interface. With this method, you can select the pages that are specified by the attribute PageSelection and you can set the active page (the page visible in the main view) with the activePage attribute.

When you create or modify a selection by using any of the previous selection option, the event Page Selection Updated (event ID: 87) is fired. This event contains a JSON payload, which details the pages that are included in the selection and whether the caret is selected.

For example, if you selected pages 1, 3, and 10 in the viewer, event 87 would contain the following JSON payload:

{"selectedPages":[{"page":{"pageNumber":1, "pipe":false}},{"page":{"pageNumber":3, "pipe":false}},{"page":{"pageNumber":10, "pipe":false}}]}

Another example, if you selected the caret before page 1 in the viewer, event 87 would contain the following JSON payload:

{"selectedPages":[{"page":{"pageNumber":1, "pipe":true}}]}

If you added a page with this selection, the new page would be number 1, and if the caret was false, it would be page number 2.

Page actions

In document builder edit mode, whenever a document builder action is performed that results in a change to the document structure, the event Document Changed (event ID: 84) is fired. This event includes a JSON payload that contains the actions that caused that particular change in the document. For example, movePage(1, 5) causes a Document Changed event with a JSON payload that contains two actions: A "remove pages" action for page 1 and a "copy pages" action for page 1 to move to position 5.

The following actions result in an event 84 to be fired:

Additional configurations

You can configure the document builder mode further with HTML and JavaScript APIs.