Summernote Editor

The Summernote Editor component enables you to add a WYSIWYG editor to your form for handling rich text with links, tables, images, videos, and character styles.

Summernote Editor is integrated into Volt MX Go Iris using custom components. A component acts as a widget configured to provide a specific feature. This component uses the Browser widget to display the UI of the Summernote Editor and enable its functionality. It links to the HTML file found in the local files associated with Summernote Editor.

Once imported, you can find the Summernote Editor component by navigating to Templates and expanding Components. Under the Modules folder of the Summernote Editor component, you can find the controller that holds the defined methods exposed to the form for usage.

Following are some use cases of the Summernote Editor component:

For replacing rich text fields during code generation of existing forms

When generating Create and Update forms for the first time, the Summernote Editor component is created before the forms to replace rich text fields and enable input of rich text content. After submitting the form, the HTML content from the editor is encoded in Base64 and stored in the rich text field. The Base64 content is decoded and displayed on the Summernote Editor component when loading the Update form.
For use in custom forms

You will find the Summernote Editor component in the Default Library. To use the Summernote Editor component, drag and drop it onto the custom form. You can then configure its placement and utilize its properties to retrieve and set data on the editor.

For more information on components, see Use Components and Creating Applications with Components.

Note

When performing code generation of forms, the Summernote Editor component is included only if a rich text field is found on the form in the Domino REST API. For more information on code generation of forms, see Generate CRUD forms for Object Service.

Methods

Methods are used by the form to interact with the Summernote Editor component.

To configure a method:

In the Project Explorer in Volt MX Go Iris, click the Templates tab.
Expand the components node, if needed, and then select the component. In this case, select Summernote Editor.
In the Properties pane, click the Action tab.
Click Manage Methods to open the Manage Methods dialog.

You can now configure the component methods. For more information, see Manage Methods.

Methods

setData
	Description	This method enables you to set a value for the Summernote Editor component.
	Syntax	`setData(data)`
	Parameters	`data` A string parameter that sets the value of the Summernote Editor component.
	Return value	none
	Remarks	Setting the value of the Summernote Editor component can be done without explicitly calling the syntax. Assigning a value on the "data" property triggers the `setData` function.
	Example	`self.instanceDetails.data = "Test"`
getData
	Description	This method enables you to get the value of the Summernote Editor component.
	Syntax	`getData()`
	Return value	Returns a string containing the HTML string content of the value entered in the Summernote Editor component.
	Remarks	Getting the value of Summernote Editor component can be done without explicitly calling the syntax. Calling the `data` property triggers the `getData` function.
	Example	`object["Details"] = self.instanceDetails.data`
checkOrRemoveFile
	Description	This method enables you to check if the Summernote Editor component has a specific attachment on its content. This method also enables you to remove the attachment file if needed.
	Syntax	`checkOrRemoveFile(fileName, removeFile = false)`
	Parameters	`fileName` A string value parameter for checking if a specified filename exists on the content of the Summernote Editor component. `removeFile` An optional boolean parameter for enabling the removal of the file from the content of the Summernote Editor component when it's set to true. By default, the parameter is set to false.
	Return value	Returns a Boolean value of true if a file exists, and false if a file isn't found in the content ofthe Summernote Editor component.
	Remarks	The `removeFile` parameter can be left out if you won't remove a file from the Summernote Editor component. Only the `fileName` parameter is required.
	Example	For only checking if a file exists: `self.instanceDetails.checkOrRemoveFile (“TestFile.pdf”)` For removing a file: `self.instanceDetails.checkOrRemoveFile(“TestFile.pdf”, true)`

Properties

You need a default property to build the Summernote Editor component. The table shows properties that hold the values of a field.

To configure a property:

In the Project Explorer in Volt MX Go Iris, click the Templates tab.
Expand the components node, if needed, and then select the component. In this case, select Summernote Editor.
In the Properties pane, click the Component tab.
Click Manage Properties to open the Manage Properties dialog.

You can now configure the component properties. For more information, see Manage Properties.

Properties

data
	Description	It's the called property when assigning or retrieving a value from the Summernote Editor component.
ID
	Description	Unique identifier consisting of alphanumeric characters.

Additional information

To learn more, see Summernote Editor.