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.
XSP (JavaScript™)
The XSP library contains classes that access the browser context.
XSPContext (JavaScript™)
Represents the context in which the server script is running.
getComponentMode (XSPContext - JavaScript™)
Gets 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.
- 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 IBM® 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.
  - DirectoryUser (JavaScript™)
    Represents a user entry in the server directory.
  - NotesXspDocument (JavaScript™)
    Represents a document associated with the XPage context in which the server script is running.
  - NotesXspViewEntry (JavaScript™)
    Represents the view entry associated with the XPage context in which the server script is running. A view entry describes a row in a view.
  - XSPContext (JavaScript™)
    Represents the context in which the server script is running.
    - bundle (XSPContext - JavaScript™)
      Loads a resource bundle from the current Domino® environment.
    - filterHTML (XSPContext - JavaScript™)
      Removes malicious active content from HTML.
    - getComponentInstanceId (XSPContext - JavaScript™)
      Gets the instance identifier of a component.
    - getComponentMode (XSPContext - JavaScript™)
      Gets the mode of a component.
    - getComponentParameter (XSPContext - JavaScript™)
      Gets the value of a component parameter.
    - getHistoryUrl (XSPContext - JavaScript™)
      Gets a URL from the navigation history of the current page.
    - getLocale (XSPContext - JavaScript™)
      Gets the current locale.
    - getLocaleString (XSPContext - JavaScript™)
      Gets the locale for the current session as a string.
    - getTimeZone (XSPContext - JavaScript™)
      Gets the current time zone.
    - getTimeZoneString (XSPContext - JavaScript™)
      Gets the current time zone as a string.
    - getUrl (XSPContext - JavaScript™)
      Gets the URL of the current page.
    - getUrlParameter (XSPContext - JavaScript™)
      Gets the value of a URL parameter from the query string.
    - getUser (XSPContext - JavaScript™)
      Gets the current user from the directory.
    - getUserAgent (XSPContext - JavaScript™)
      Gets the User-Agent request header field of the HTTP request sent from the browser.
    - isComponent (XSPContext - JavaScript™)
      Checks if the runtime context is a component.
    - isDataBeingLoaded (XSPContext - JavaScript™)
      Checks if the current document is being loaded.
    - isDataBeingSaved (XSPContext - JavaScript™)
      Checks if the current document is being saved.
    - isDirectionLTR (XSPContext - JavaScript™)
      Checks if the base direction of text is left to right.
    - isDirectionRTL (XSPContext - JavaScript™)
      Checks if the base direction of text is right to left.
    - redirectToHome (XSPContext - JavaScript™)
      Opens the home page for the current application.
    - redirectToPage (XSPContext - JavaScript™)
      Opens another page replacing the current page.
    - redirectToPrevious (XSPContext - JavaScript™)
      Opens the previous page in the navigation history, replacing the current page.
    - reloadPage (XSPContext - JavaScript™)
      Reloads the page.
    - setComponentMode (XSPContext - JavaScript™)
      Sets the mode of a component.
    - setComponentParameter (XSPContext - JavaScript™)
      Sets the value of a component parameter.
    - setLocale (XSPContext - JavaScript™)
      Sets the locale for the current session.
    - setLocaleString (XSPContext - JavaScript™)
      Sets the locale for the current session as a string.
    - setTimeZone (XSPContext - JavaScript™)
      Sets the time zone for the current session.
    - setTimeZoneString (XSPContext - JavaScript™)
      Sets the time zone for the current session as a string.
  - XSPUrl (JavaScript™)
    Represents a URL.
  - XSPUserAgent (JavaScript™)
    Represents the User-Agent request header field of the HTTP request sent from the browser.

getComponentMode (XSPContext - JavaScript™)

Gets the mode of a component.

Defined in

Syntax

getComponentMode() : string


Return value	Description
`string`	The component mode: `view`, `edit`, or `help`.