Home
JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
Simple actions (JavaScript)
A simple action performs a pre-programmed activity that can be modified by arguments.
Set Component Mode Action (Simple actions)
Changes the mode of a component.

JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
- JavaScript™ language elements (JavaScript™)
  The JavaScript™ language elements are based on the ECMAScript Language Specification Standard ECMA-262 (see http://www.ecma-international.org/publications/standards/Ecma-262.htm). The JavaScript described here applies to the server-side interpreter. Client-side scripts are interpreted by the browser.
- Simple actions (JavaScript)
  A simple action performs a pre-programmed activity that can be modified by arguments.
  - Change Document Mode (Simple actions)
    Changes the access mode for the current page.
  - Confirm Action (Simple actions)
    Confirms an action.
  - Create Response Document (Simple actions)
    Creates a response document and opens it as a new document.
  - Delete Document (Simple actions)
    Deletes the current document and opens a new page.
  - Delete Selected Documents (Simple actions)
    Deletes documents selected in a view.
  - Execute Client Script (Simple actions)
    Executes a client-side script.
  - Execute Script (Simple actions)
    Executes a script or EL expression.
  - In Place Form Action (Simple actions)
    Shows or hides In Place Form controls that are commonly used for the in place editing of an individual document - directly within a Repeat control that lists multiple documents.
  - Modify Field (Simple actions)
    Modifies a field in the current document.
  - Open Page (Simple actions)
    Replaces the current page.
  - Publish Component Property (Simple actions)
    Publishes a component event.
  - Publish View Column (Simple actions)
    Publishes the value of a view column as a component event.
  - Save Data Sources (Simple actions)
    Saves all the data sources on the current page and opens a new page.
  - Save Document (Simple actions)
    Saves the current document.
  - Send Mail (Simple actions)
    Sends a mail message.
  - Set Component Mode Action (Simple actions)
    Changes the mode of a component.
  - Set Value (Simple actions)
    Sets the value of a computed expression.
- Global objects and functions (JavaScript™)
  Global objects provide entry points to server-side scripts. Entering the name of a global object instantiates it.
- DOM (JavaScript)
  Represents a document in XML Document Object Model format.
- Domino®
  This library provides access to the HCL Domino® back-end.
- Runtime (JavaScript)
  The Runtime library contains classes that provide useful methods for globalization.
- Standard (JavaScript)
  The Standard library contains classes for manipulating data of different types and performing common operations.
- XSP (JavaScript™)
  The XSP library contains classes that access the browser context.

Set Component Mode Action (Simple actions)

Changes the mode of a component.

Defined in

Type of simple action

Component (Client)

Syntax

Note: This is the XSP source code. The UI presents the simple action as a dialog with a box for each argument.

setComponentMode cancel="true" mode="edit"


Arguments	Description	UI presentation
`cancel`	Indicates if the mode is changed through a cancel button.	A dropdown list plus the diamond icon. You can select true or false, or click the diamond to dynamically compute the value.
`mode`	The new mode: `view`, `edit`, or `help`.	An edit box plus the diamond icon. You can type a string into the field or click the diamond to dynamically compute the value.

Usage

See "Working with components in XPages" in the HCL Domino® Designer User Guide for guidelines on components.

Component modes are used by Mashups.

Examples

Note: These examples present XSP source code which can be inserted under the Source tab taking care to keep the XML well formed. To use the UI, select or enter the arguments in the simple action dialog.

This button changes the mode of a component.

<xp:button value="Label" id="button1"><xp:eventHandler event="onclick" submit="true" refreshMode="complete" id="eventHandler1">
	<xp:this.action id="this.action2">
		<xp:setComponentMode cancel="true" mode="edit"></xp:setComponentMode>
	</xp:this.action></xp:eventHandler></xp:button>