Home
IBM Domino Designer XPages User Guide
This guide focuses on the aspects of creating applications using XPages technology.
Designing XPages applications
IBM® Domino® Designer provides the means to populate an XPage with controls and other artifacts, and to associate an XPage with data stores.
Adding controls
Controls are visual elements such as edit boxes, buttons, images, and text that allow users to manipulate data on an XPage.
Control reference
Specified here are the XPages controls.
inputRichText - Rich Text
Displays an input field for entering data formatted as rich text.

IBM Domino Designer XPages User Guide
This guide focuses on the aspects of creating applications using XPages technology.
- Product overview
  IBM® Domino® Designer supports applications development for the IBM Domino platform using XPages, forms, views, and other elements such as controls.
- Tutorials
  This section contains tutorials and information about tutorials.
- Administering applications
  IBM® Domino® Designer provides features for administering and managing your work and related files while developing your application projects.
- Designing XPages applications
  IBM® Domino® Designer provides the means to populate an XPage with controls and other artifacts, and to associate an XPage with data stores.
  - Previewing and running XPages
    XPages run in Domino® server and Notes® client environments. From Domino Designer, you can preview XPages in both environments.
  - Adding controls
    Controls are visual elements such as edit boxes, buttons, images, and text that allow users to manipulate data on an XPage.
    - Manipulating controls and text
      You can add controls and text to an XPage using the Design or Source editor. The Controls palette provides a source for controls.
    - Using an extension point to override design time tooling for Core and Extension Library controls
      An extension point is provided to let you override design time tooling for the Core and Extension Library controls that are shipped with Designer.
    - Setting properties
      Properties define XPages and controls.
    - Understanding events
      Events are actions that a user might perform such as clicking a button or removing focus from an edit box. Event handlers are actions that you (the designer) perform in response to events.
    - Understanding facets
      A facet defines a region in a control for the placement of other controls.
    - Understanding Dojo widgets
      Dojo widgets are prepackaged JavaScript™ code, HTML, and CSS declarations that enhance the appearance and use of controls in both a browser and the Notes® client.
    - Control reference
      Specified here are the XPages controls.
      - br - Line break
        Inserts a break in text.
      - button - Button
        Displays a button that the user can click to perform an action.
      - callback - Editable Area
        Provides a custom control with an area that can be edited when embedded in an XPage.
      - checkBox - Check Box
        Displays a box that can be selected or cleared.
      - checkBoxGroup - Check Box Group
        Displays multiple boxes that can be selected or cleared.
      - comboBox - Combo Box
        Displays a list of items one of which can be selected.
      - dataTable - Data Table
        Contains cells arranged as rows and columns associated with a data source. Each cell can contain other controls (including tables) and text.
      - dateTimeHelper - Date Time Picker
        Displays a picker for selection of date and time values in an edit box.
      - div - Division
        Acts as a division or block of content in HTML. Contains other controls and text.
      - eventHandler - Event Handler (control)
        Responds to user actions such as clicking a control.
      - fileDownload - File Download
        Downloads a file to the local file system.
      - fileUpload - File Upload
        Uploads a file from the local file system.
      - image - Image
        Displays an image.
      - include - Include Page
        Inserts a reference to another XPage.
      - inputHidden - Hidden Input
        Hides data from the user.
      - inputRichText - Rich Text
        Displays an input field for entering data formatted as rich text.
      - inputText - Edit Box
        Displays an input field for entering one line of data.
      - inputTextarea - Multiline Edit Box
        Displays an input field for entering multiple lines of data.
      - label - Label (control)
        Displays text.
      - link - Link
        Opens a URL, a control (anchor link), or another XPage.
      - listBox - List Box
        Displays a list of items one or more of which can be selected.
      - message - Display Error
        Displays error messages for one control.
      - messages - Display Errors
        Displays error messages for all controls on a page.
      - pager - Pager
        Pages data for a container control where its data cannot be displayed in one window.
      - pagerControl - Pager Child Control
        Specifies a pager control within the common pager.
      - panel - Panel
        Serves as a container for other controls and text with common data sources and properties.
      - paragraph - Paragraph
        Combines text in a paragraph format.
      - platformEvent - Platform Event Control
        Handles a platform event.
      - radio - Radio Button
        Displays a button that can be selected or cleared. When grouped only one button in the group can be selected.
      - radioGroup - Radio Button Group
        Displays multiple buttons that can be selected or cleared. Only one button in the group can be selected.
      - repeat - Repeat
        Repeats embedded controls by iterating through a data source.
      - scriptBlock - Output Script
        Outputs a client script.
      - section - Section
        Serves as a collapsible container for other controls and text
      - selectItem - Selection Item
        Provides an item for user selection, for example, in a check box.
      - selectItems - Selection Items
        Provides one or more items for user selection, for example, in a check box.
      - span - Span Content
        Combines text, typically for the application of properties.
      - tabbedPanel - Tabbed Panel
        Serves as a collection of containers for other controls and text.
      - table - Table
        Contains cells arranged as rows and columns. Each cell can contain other controls (including tables) and text.
      - text - Computed Field
        Displays a value.
      - typeAhead - AJAX Type ahead
        Automatically fills in its parent control as users type a succession of characters that match a specified suggestion.
      - view - XPage
        Defines the top-level container control, that is, the XPage itself.
      - viewPanel - View
        Displays data from documents in rows and columns.
    - Property reference
      Specified here are the XPages properties.
    - Designing with custom controls in XPages
      A custom control is a collection of controls that are stored as a single object. Similar to the way a subform can be placed on more than one form, a custom control can be created once and added to multiple XPages. When you update a custom control, every XPage that uses that custom control automatically gets updated with the changes. This saves you design time because you do not have to update each XPage separately.
  - Adding controls from the XPages Extension Library
    The XPages Extension Library provides additional controls ready to use. The controls include an application layout object, an improved dialog, pickers, in place forms, Dojo components, dynamic content, and much more. The controls support enhancements to the Domino(r)® templates.
  - Binding and submitting data
    The data store for XPages is Domino®. You can access the data store through Domino forms and views.
  - Adding images, styles, and themes
    You can enhance your design with images, styles, and themes.
  - Responsive web design support in XPages
    The XPages Extension Library supports Bootstrap, a Responsive Web Design (RWD) framework. This support comes in the form of an XPages Responsive Bootstrap plugin that you can use in your XPages applications.
  - Using Domino® Designer with XPages in Bluemix™
    IBM® Domino® Designer is designed to work with IBM Bluemix™, the cloud-based application development environment.
- Designing composite applications
  You can create composite applications from XPages.
- Programming
  XPages uses JavaScript™ for programming while the forms-based design elements use the formula language, LotusScript®, Java™, and JavaScript.

inputRichText - Rich Text

Displays an input field for entering data formatted as rich text.

Category

Core Controls

Syntax

<xp:inputRichText attributes>content</xp:inputRichText>

Table 1. Essential properties
Property	Description
id	Defaults to `inputRichText1`, `inputRichText2`, and so on.
value	Binds the control to a data element or other value.

Table 2. All properties
Category	Properties
accessibility	accesskey, role, tabindex, title
basics	attrs, binding, dir, disabled, htmlConversionWarning, htmlFilter, htmlFilterIn, id, immediate, lang, loaded, multipleSeparator, multipleTrim, readonly, rendered, rendererType, required
data	converter, defaultValue, disableClientSideValidation, disableModifiedFlag, showReadonlyAsDisabled, validator, validators, value, valueChangeListener, valueChangeListeners
dojo	dojoAttributes, dojoType
events	onblur, onchange, onclick, onfocus, onkeydown, onkeypress, onkeyup
styling	disableTheme, outerStyleClass, style, styleClass, themeId

Usage

At run time, an edit box with a tool bar appears on the page. The user can enter text with attributes such as boldface and italics. and insert tables, attachments, embedded objects, and other artifacts.

The CKEditor (http://ckeditor.com) is the default rich text editor for XPages. This editor permits the embedding of images, tables, links, and emoticons. The editor includes a spell checker.

You can adjust the toolbar that is rendered. With the rich text control in focus, click the Dojo tab and add an attribute (dojoAttributes property) named toolbarType with a value of lite, medium, or full.

You can revert to the Dojo rich text editor. With the rich text control in focus, click the Dojo tab and specify the Dojo type (dojoType property) as ibm.xsp.widget.layout.RichText.

Examples

This Rich Text control is bound to a field on a Domino® form.

<xp:inputRichText id="inputRichText1" value="#{document1.body}"></xp:inputRichText>

This Rich Text control uses the Dojo editor.

<xp:inputRichText id="inputRichText1"
	value="#{document1.body}" dojoType="ibm.xsp.widget.layout.RichText">
</xp:inputRichText>

This Rich Text control renders a full toolbar.

<xp:inputRichText id="inputRichText1" value="#{document1.body}">
	<xp:this.dojoAttributes>
		<xp:dojoAttribute name="toolbarType" value="full"></xp:dojoAttribute>
	</xp:this.dojoAttributes>
</xp:inputRichText>