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 IBM® 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>