Home
Reference
The documents in this section provide reference material and samples for HCL Domino Volt .
JavaScript™ API
Reference Objects and Functions
Describes the Functions available on different parts of the HCL Domino Volt object model.
Interface objects
The following topics describe and gives samples for interface objects that are used within the HCL Domino Volt JavaScript™ API.

Reference
The documents in this section provide reference material and samples for HCL Domino Volt .
- REST API reference
  The REST API can be used by other programs to communicate with Domino Volt.
- JavaScript™ API
  - Running Custom JavaScript™ – Events
    Custom JavaScript™ is run in response to events in the form. These events can be triggered at the application, form, page, and item level in response to form lifecycle changes, and to user interactions. A list of the events available, and how to interact with the form using them is shown in the following list.
  - Running Custom JavaScript™ Files
    Custom JavaScript™ can also be loaded from attached JavaScript files. Any .js file that is added to the application in the Settings > Files section is automatically loaded into your running application. An associated JavaScript file is evaluated once when the browser first loads the running application, and is not called in response to any events.
  - Reference Objects and Functions
    Describes the Functions available on different parts of the HCL Domino Volt object model.
    - Interface objects
      The following topics describe and gives samples for interface objects that are used within the HCL Domino Volt JavaScript™ API.
    - Data objects
      This topic describes and gives samples for data objects used within the HCL Domino Volt JavaScript™ API.
    - JavaScript™ Security
      The dojox.secure library is used to restrict the JavaScript™-provided clients to a safe sandbox so they cannot do anything malicious. However, this imposes a number of limitations.
- Services
  The following topics provide reference information about adding services to HCL Volt.
- Embedding items in an iframe
  You can use iFrames to embed charts and applications in a web page.
- Embedding API
  The Embedding API is used to embed a Volt form directly in another webpage without using an <iframe>. The Volt form is inserted into the DOM of the hosting page and can be interacted with using the JavaScript API or any custom JavaScript. Additionally, the style of items in the form can be customized by the CSS of the hosting page.
- Creating customized Cascading Style Sheets
  You can apply your own custom Cascading Style Sheet (CSS) to the rendering of your HCL Domino Volt application. To create a custom theme, you must be familiar with the basic concepts of CSS.

Interface objects

The following topics describe and gives samples for interface objects that are used within the HCL Domino Volt JavaScript™ API.

Note: When you use JavaScript™ to modify form items, the change appears only in the user interface, it does not persist to the submitted data. The user completing the form sees the modifications that are made by your JavaScript™, however a user reviewing submitted data sees the original form items. If you want the changes to appear in the form any time it is viewed, the JavaScript™ must be attached to events that run each time that the form is opened.