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.
NotesXspDocument (JavaScript™)
Represents a document associated with the XPage context in which the server script is running.
getForm (NotesXspDocument - JavaScript™)
Gets the name of the document's form.

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 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.
  - 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.
    - encrypt (NotesXSPDocument - JavaScript™)
      Encrypts a document associated with the XPage context in which the server script is running.
    - EncryptionKeys (NotesXSPDocument - JavaScript™)
      Read-Write. The key(s) used to encrypt a document associated with the XPage context in which the server script is running.
    - getEmbeddedImagesList (NotesXSPDocument - JavaScript™)
      Takes a string argument which is the name of a rich text field in a document. If the field name is valid, it returns a list of embedded images, if any, found in that rich text item.
    - IsEncrypted (NotesXSPDocument - JavaScript™)
      Read-only. Indicates whether a document associated with the XPage context in which the server script is running is encrypted.
    - getAttachmentList (NotesXspDocument - JavaScript™)
      Gets the attachments in the document.
    - getDocument (NotesXspDocument - JavaScript™)
      Gets the document as a NotesDocument object.
    - getForm (NotesXspDocument - JavaScript™)
      Gets the name of the document's form.
    - getItemValue (NotesXspDocument - JavaScript™)
      Gets the value of an item as a vector.
    - getItemValueArray (NotesXspDocument - JavaScript™)
      Gets the value of an item as an array.
    - getItemValueDate (NotesXspDocument - JavaScript™)
      Gets the value of an item as a date.
    - getItemValueDateTime (NotesXspDocument - JavaScript™)
      Gets the value of an item as a Notes® date/time.
    - getItemValueDouble (NotesXspDocument - JavaScript™)
      Gets the value of an item as a double.
    - getItemValueInteger (NotesXspDocument - JavaScript™)
      Gets the value of an item as a integer.
    - getItemValueString (NotesXspDocument - JavaScript™)
      Gets the value of an item as a string.
    - getNoteID (NotesXspDocument - JavaScript™)
      Gets the note ID of the current document.
    - getParentDatabase (NotesXspDocument - JavaScript™)
      Gets the parent database of the document.
    - getParentId (NotesXspDocument - JavaScript™)
      Gets the note ID of the parent of the current document.
    - getValue (NotesXspDocument - JavaScript™)
      Gets the value of an item.
    - hasItem (NotesXspDocument - JavaScript™)
      Checks if the document contains an item.
    - isEditable (NotesXspDocument - JavaScript™)
      Checks if the current document is in edit mode.
    - IsEncrypted (NotesXSPDocument - JavaScript™)
      Read-only. Indicates whether a document associated with the XPage context in which the server script is running is encrypted.
    - isNewNote (NotesXspDocument - JavaScript™)
      Checks if a new document is being created.
    - isResponse (NotesXspDocument - JavaScript™)
      Checks if the current document is a response document.
    - removeAllAttachments (NotesXspDocument - JavaScript™)
      Removes all attachments from a document item.
    - removeAttachment (NotesXspDocument - JavaScript™)
      Removes an attachment in the document.
    - removeItem (NotesXspDocument - JavaScript™)
      Removes an item.
    - replaceItemValue (NotesXspDocument - JavaScript™)
      Replaces the value of an item.
    - save (NotesXspDocument - JavaScript™)
      Saves the document in the data store.
    - setValue (NotesXspDocument - JavaScript™)
      Sets the value of an item.
  - 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.
  - XSPUrl (JavaScript™)
    Represents a URL.
  - XSPUserAgent (JavaScript™)
    Represents the User-Agent request header field of the HTTP request sent from the browser.

getForm (NotesXspDocument - JavaScript™)

Gets the name of the document's form.

Syntax

getForm() : string


Return value	Description
`string`	The name of the form.

Examples

This code computes the form for a data source, specifying it as the same form used for document1.

return document1.getForm()