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.
Domino®
This library provides access to the HCL Domino® back-end.
NotesView (JavaScript™)
Represents a view or folder of a database and provides access to documents within it.
Spacing (NotesView - JavaScript™)
Read-write. The spacing between rows of a view.

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.
  - NotesACL (JavaScript™)
    Represents the access control list (ACL) of a database.
  - NotesACLEntry (JavaScript™)
    Represents a single entry in an access control list. An entry may be for a person, a group, or a server.
  - NotesAdministrationProcess (JavaScript™)
    Represents the administration process. Note This class is new with Release 6.5.
  - NotesAgent (JavaScript™)
    Represents an agent.
  - NotesAgentContext (JavaScript™)
    Represents the agent environment of the current program, if an agent is running it.
  - NotesBase (JavaScript™)
    Defines methods that are common to all the classes.
  - NotesCalendar (JavaScript™)
    Represents a Domino® calendar.
  - NotesCalendarEntry (JavaScript™)
    Represents a Domino® calendar entry.
  - NotesCalendarNotice (JavaScript™)
    Represents a Domino® calendar notice.
  - NotesColorObject (JavaScript™)
    Represents a color.
  - NotesDatabase (JavaScript™)
    Represents a Notes® database.
  - NotesDateRange (JavaScript™)
    Represents a range of dates and times.
  - NotesDateTime (JavaScript™)
    Represents a date and time.
  - NotesDbDirectory (JavaScript™)
    Represents the Domino® databases on a server or the local computer.
  - NotesDirectory (JavaScript™)
    Represents the Notes® directories on a specific server or local computer, each of which is associated with one or more directory navigators to allow directory lookups.
  - NotesDirectoryNavigator (JavaScript™)
    Allows lookups of a specific associated Notes® directory on a specific server or local computer.
  - NotesDocument (JavaScript™)
    Represents a document in a database.
  - NotesDocumentCollection (JavaScript™)
    Represents a collection of documents from a database.
  - NotesDxlExporter (JavaScript™)
    Represents the conversion of Domino® data to DXL (Domino XML). Note This class is new with Release 6.5.
  - NotesDxlImporter (JavaScript™)
    Represents the conversion of DXL (Domino® XML) to Domino data. Note This class is new with Release 6.5.
  - NotesEmbeddedObject (JavaScript™)
    Represents any one of the following: An embedded object An object link A file attachment Note Embedded objects and object links are not supported for UNIX™, and the Macintosh. File attachments are supported.
  - NotesForm (JavaScript™)
    Represents a form in a database.
  - NotesIDVault (JavaScript™)
    The NotesIDVault class is a representation of the secure storage facility for UserIDs that may be configured for Domino by policy. IDs are stored there to allow for easier management by administrators and users. IDs from more than one server may be stored within an IDVault. The NotesIDVault class provides methods to access UserID files, UserID objects, query the presence of an ID in the vault, sycnronise copies of IDs, and reset passwords. The NotesIDVault class can be used to access UserID objects or files. These can be used to accomplish the encryption or decryption of Documents while running on the server.
  - NotesInternational (JavaScript™)
    Represents the international settings in the operating environment, for example, the Regional Settings in the Windows™ Control Panel. When settings change in the operating environment, Notes® recognizes the new settings immediately. For remote (IIOP) operations, these settings represent the session's server.
  - NotesItem (JavaScript™)
    Represents a discrete value or set of values in a document. The client interface displays items in a document through fields on a form. When a field on a form and an item in a document have the same name, the field displays the item (for example, the Subject field displays the Subject item). All items in a document are accessible programmatically, regardless of what form is used to display the document in the user interface.
  - NotesLog (JavaScript™)
    Enables you to record actions and errors that take place during a program's execution. You can record actions and errors in: A Domino® database A mail memo A file (for programs that run locally) An agent log (for agents)
  - NotesMIMEEntity (JavaScript™)
    Represents an item of type MIME (Multipurpose Internet Mail Extensions).
  - NotesMIMEHeader (JavaScript™)
    Represents a header in a MIME (Multipurpose Internet Mail Extensions) document.
  - NotesName (JavaScript™)
    Represents a user or server name.
  - NotesNewsletter (JavaScript™)
    Document or set of documents that contains information from, or links to, several other documents.
  - NotesNoteCollection (JavaScript™)
    Represents a collection of Domino® design and data elements in a database.
  - NotesOutline (JavaScript™)
    Represents an outline in a database.
  - NotesOutlineEntry (JavaScript™)
    Represents an entry in an outline.
  - NotesProperty (JavaScript™)
    Represents a single property in the Composite Applications properties of a Domino® application. Properties are data transmitted to or from the Property Broker, which routes your application's communication with other components in a composite application. Properties are defined in a Wiring Properties design element.
  - NotesPropertyBroker (JavaScript™)
    Mediates communication between components of a composite application, allowing communication between multiple Java™ components, or between Notes® and Java components.
  - NotesRegistration (JavaScript™)
    Represents the creation or administration of an ID file.
  - NotesReplication (JavaScript™)
    Represents the replication settings of a database.
  - NotesReplicationEntry (JavaScript™)
    Represents the replication settings for a pair of servers in a database.
  - NotesRichTextDoclink (JavaScript™)
    Represents a doclink in a rich text item.
  - NotesRichTextItem (JavaScript™)
    Represents an item of type rich text.
  - NotesRichTextNavigator (JavaScript™)
    Represents a means of navigation in a rich text item.
  - NotesRichTextParagraphStyle (JavaScript™)
    Represents rich text paragraph attributes.
  - NotesRichTextRange (JavaScript™)
    Represents a range of elements in a rich text item.
  - NotesRichTextSection (JavaScript™)
    Represents a collapsible section in a rich text item.
  - NotesRichTextStyle (JavaScript™)
    Represents rich-text attributes.
  - NotesRichTextTab (JavaScript™)
    Represents a tab in a rich text paragraph style.
  - NotesRichTextTable (JavaScript™)
    Represents a table in a rich text item.
  - NotesSession (JavaScript™)
    This class is the root of the Domino® Objects containment hierarchy, providing access to the other Domino objects, and represents the Domino server or Notes® client environment of the current program.
  - NotesStream (JavaScript™)
    Represents a stream of binary or character data. The stream can be associated with a file.
  - NotesUserID (JavaScript™)
    The NotesUserID class represents the Notes ID file or a Notes ID when it resides within the Domino IDVault. This object is primarily used to obtain the names of the private encryption keys which are available for use within the UserID object.
  - NotesView (JavaScript™)
    Represents a view or folder of a database and provides access to documents within it.
    - Aliases (NotesView - JavaScript™)
      Read-write. The aliases of a view.
    - AllEntries (NotesView - JavaScript™)
      Read-only. All document entries in a view in view order.
    - BackgroundColor (NotesView - JavaScript™)
      Read-write. The background color of a view.
    - ColumnCount (NotesView - JavaScript™)
      Read-only. The number of columns in a view.
    - ColumnNames (NotesView - JavaScript™)
      Read-only. The names of the columns in a view.
    - Columns (NotesView - JavaScript™)
      Read-only. The columns in a view.
    - Created (NotesView - JavaScript™)
      Read-only. The date and time when a view was created.
    - EntryCount (NotesView - JavaScript™)
      Read-only. The number of documents in a view.
    - HeaderLines (NotesView - JavaScript™)
      Read-only. The number of lines in the header of a view.
    - HttpURL (NotesView - JavaScript™)
      Read-only. The Domino® URL of a view when HTTP protocols are in effect.
    - IsAutoUpdate (NotesView - JavaScript™)
      Read-write. Indicates whether a view is automatically refreshed when a navigation method touches an update (addition, deletion, or change) to the database that occurred after view creation or the last refresh.
    - IsCalendar (NotesView - JavaScript™)
      Read-only. Indicates whether a view is a calendar view.
    - IsCategorized (NotesView - JavaScript™)
      Read-only. Indicates whether a view is categorized.
    - IsConflict (NotesView - JavaScript™)
      Read-only. Indicates whether a view is enabled for conflict checking.
    - IsDefaultView (NotesView - JavaScript™)
      Read-write. Indicates whether a view is the default view of the database.
    - IsFolder (NotesView - JavaScript™)
      Read-only. Indicates whether a NotesView object represents a folder.
    - IsHierarchical (NotesView - JavaScript™)
      Read-only. Indicates whether a view shows response documents in a hierarchy.
    - IsModified (NotesView - JavaScript™)
      Read-only. Indicates whether a view is modified.
    - IsPrivate (NotesView - JavaScript™)
      Read-only. Indicates whether a view is private or shared on first use.
    - IsProhibitDesignRefresh (NotesView - JavaScript™)
      Read-write. Indicates whether a design refresh or replace can overwrite a view.
    - IsProtectReaders (NotesView - JavaScript™)
      Read-Write. Protects $Readers items from being overwritten by replication.
    - IsQueryView (NotesView - JavaScript™)
      Read-only. Indicates whether a view is a DB2® query view.
    - LastModified (NotesView - JavaScript™)
      Read-only. The date that a view was last modified.
    - LockHolders (NotesView - JavaScript™)
      Read-only. The names of the holders of a lock.
    - Name (NotesView - JavaScript™)
      Read-write. The name of a view.
    - NotesURL (NotesView - JavaScript™)
      Read-only. The Domino® URL of a view when Notes® protocols are in effect.
    - Parent (NotesView - JavaScript™)
      Read-only. The database to which a view belongs.
    - Readers (NotesView - JavaScript™)
      Read-Write. The contents of the $Readers field associated with the view.
    - RowLines (NotesView - JavaScript™)
      Read-only. The number of lines in each row of a view.
    - SelectionFormula (NotesView - JavaScript™)
      Read-write. The selection formula of a view.
    - SelectionQuery (NotesView - JavaScript™)
      Read-write. The selection query of a DB2® query view.
    - Spacing (NotesView - JavaScript™)
      Read-write. The spacing between rows of a view.
    - TopLevelEntryCount (NotesView - JavaScript™)
      Read-only. The number of top-level entries in a view.
    - UniversalID (NotesView - JavaScript™)
      Read-only. The universal ID of a view, which is a 32-character hexadecimal value that uniquely identifies a view across all replicas of a database.
    - ViewInheritedName (NotesView - JavaScript™)
      Read-only. The name of the view whose design a view inherits.
    - clear (NotesView - JavaScript™)
      Clears the full-text search filtering on a view.
    - copyColumn (NotesView - JavaScript™)
      Creates a new column by copying an existing one.
    - createColumn (NotesView - JavaScript™)
      Creates a new column.
    - createViewEntryCollection (NotesView - JavaScript™)
      Creates an empty view entry collection.
    - createViewNav (NotesView - JavaScript™)
      Creates a view navigator for all entries in a view.
    - createViewNavFrom (NotesView - JavaScript™)
      Creates a view navigator for all entries in a view starting at a specified entry.
    - createViewNavFromAllUnread (NotesView - JavaScript™)
      Creates a view navigator for all unread entries in a view.
    - createViewNavFromCategory (NotesView - JavaScript™)
      Creates a view navigator for all entries in a view under a specified category.
    - createViewNavFromChildren (NotesView - JavaScript™)
      Creates a view navigator for the immediate children of a specified entry.
    - createViewNavFromDescendants (NotesView - JavaScript™)
      Creates a view navigator for all the descendants of a specified entry.
    - createViewNavMaxLevel (NotesView - JavaScript™)
      Creates a view navigator for all entries in a view down to a specified level.
    - FTSearch (NotesView - JavaScript™)
      Conducts a full-text search on all documents in a view and filters the view so it represents only those documents that match the full-text query.
    - FTSearchSorted (NotesView - JavaScript™)
      Conducts a full-text search on all documents in a view and filters the view so it represents only those documents that match the full-text query in sorted order.
    - getAllDocumentsByKey (NotesView - JavaScript™)
      Finds documents based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all documents whose column values match the keys.
    - getAllEntriesByKey (NotesView - JavaScript™)
      Finds view entries of type document based on their column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns all entries whose column values match the keys.
    - getAllReadEntries (NotesView - JavaScript™)
      The method returns all entries associated with documents that have been read.
    - getAllUnreadEntries (NotesView - JavaScript™)
      The method returns all entries associated with documents that have not been read.
    - getChild (NotesView - JavaScript™)
      Given a document in a view, returns the first response to the document.
    - getColumn (NotesView - JavaScript™)
      Returns a specified column in a view.
    - getColumnValues (NotesView - JavaScript™)
      Gets the value of each row in a column.
    - getDocumentByKey (NotesView - JavaScript™)
      Finds a document based on its column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns the first document with column values that match the keys.
    - getEntryByKey (NotesView - JavaScript™)
      Finds a view entry of type document based on its column values within a view. You create a key or vector of keys, where each key corresponds to a value in a sorted column in the view. The method returns the first entry with column values that match the keys.
    - getFirstDocument (NotesView - JavaScript™)
      Returns the first document in a view.
    - getLastDocument (NotesView - JavaScript™)
      Returns the last document in a view.
    - getNextDocument (NotesView - JavaScript™)
      Given a document in a view, returns the document immediately following it.
    - getNextSibling (NotesView - JavaScript™)
      Given a document in a view, returns the document immediately following it at the same level. If you send the method a main document, the next main document in the view is returned. If you send a response document, the next response document with the same parent is returned. If the view is categorized, the next sibling is in the same category as the original document.
    - getNthDocument (NotesView - JavaScript™)
      Returns the document at a specified position in the top level of a view.
    - getParentDocument (NotesView - JavaScript™)
      Given a response document in a view, returns its parent document.
    - getPrevDocument (NotesView - JavaScript™)
      Given a document in a view, returns the document immediately preceding it.
    - getPrevSibling (NotesView - JavaScript™)
      Given a document in a view, returns the document immediately preceding it at the same level. If you use this method on a main document, the preceding main document in the view is returned. If you use it on a response document, the preceding response document with the same parent is returned. If the view is categorized, the previous sibling is in the same category as the original document.
    - getURL (NotesView - JavaScript™)
      Gets the Domino® URL for the view.
    - lock (NotesView - JavaScript™)
      Locks a view.
    - lockProvisional (NotesView - JavaScript™)
      Locks a view provisionally.
    - markAllRead (NotesView - JavaScript™)
      Marks all documents in the view as read.
    - markAllUnread (NotesView - JavaScript™)
      Marks all documents in the view as unread.
    - refresh (NotesView - JavaScript™)
      Updates view contents to reflect any updates to the database since the NotesView object was created, or since the last refresh.
    - remove (NotesView - JavaScript™)
      Permanently removes a view from a database.
    - removeColumn (NotesView - JavaScript™)
      Removes a column.
    - resortView (NotesView - JavaScript™)
      Resorts a view.
    - setAliases (NotesView - JavaScript™)
      Sets the aliases of a view.
    - unlock (NotesView - JavaScript™)
      Unlocks a view.
  - NotesViewColumn (JavaScript™)
    Represents a column in a view or folder.
  - NotesViewEntry (JavaScript™)
    Represents a view entry.
  - NotesViewEntryCollection (JavaScript™)
    Represents a collection of view entries of type document sorted in view order.
  - NotesViewNavigator (JavaScript™)
    Represents a view navigator. A view navigator provides access to all or a subset of the entries in a view.
  - NotesXSLTResultTarget (JavaScript™)
    Contains the result of a transformation by the XSL processor.
- 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.

Spacing (NotesView - JavaScript™)

Read-write. The spacing between rows of a view.

Defined in

Syntax

getSpacing() : int

setSpacing(spacing:int) : void

Legal value

The NotesView class provides the following named values (actual values in parentheses):

NotesView.SPACING_SINGLE (0)
NotesView.SPACING_ONE_POINT_25 (1)
NotesView.SPACING_ONE_POINT_50 (2)
NotesView.SPACING_ONE_POINT_75 (3)
NotesView.SPACING_DOUBLE (4)
NotesView.VW_SPACING_SINGLE (0)
NotesView.VW_SPACING_ONE_POINT_25 (1)
NotesView.VW_SPACING_ONE_POINT_50 (2)
NotesView.VW_SPACING_ONE_POINT_75 (3)
NotesView.VW_SPACING_DOUBLE (4)

Examples

This button toggles the spacing for a view associated with a page.

switch (view1.getSpacing()) {
	case NotesView.SPACING_SINGLE :
		view1.setSpacing(NotesView.SPACING_ONE_POINT_25);
		requestScope.status = "Spacing set to 1.25";
		break;
	case NotesView.SPACING_ONE_POINT_25 :
		view1.setSpacing(NotesView.SPACING_ONE_POINT_50);
		requestScope.status = "Spacing set to 1.5";
		break;
	case NotesView.SPACING_ONE_POINT_50 :
		view1.setSpacing(NotesView.SPACING_ONE_POINT_75);
		requestScope.status = "Spacing set to 1.75";
		break;
	case NotesView.SPACING_ONE_POINT_75 :
		view1.setSpacing(NotesView.SPACING_DOUBLE);
		requestScope.status = "Spacing set to double";
		break;
	default:
		view1.setSpacing(NotesView.SPACING_SINGLE);
		requestScope.status = "Spacing set to single";
}