Jump to main content
HCL Logo Product Documentation
Customer Support HCLSoftware U Community Forums Customer Idea Portal
IBM Domino Designer
  • IBM Domino Designer Basic User Guide and Reference
  • Designer XPages User Guide
  • JavaScript and XPages reference
  1. Home
  2. 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.

  3. Domino®

    This library provides access to the IBM® Domino® back-end.

  4. 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.

  5. createRichTextStyle (NotesSession - JavaScript™)

    Creates a new RichTextStyle object.

 Go to Feedback
  • 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.

      • 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 OS/2, 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.

        • AddressBooks (NotesSession - JavaScript™)

          Read-only. The Domino® Directories and Personal Address Books, including directory catalogs, known to the current session.

        • ApplicationShouldQuit (Session - JavaScript™)

          Provides the backend interface for OSProcessShouldQuit. Returns a value of True if this process should quit.

        • AgentContext (NotesSession - JavaScript™)

          Read-only. Represents the agent environment of the current program, if an agent is running it.

        • CommonUserName (NotesSession - JavaScript™)

          Read-only. The common name of the user that created the session.

        • EffectiveUserName (NotesSession - JavaScript™)

          Read-only. The login name of the user that created the session.

        • HttpURL (NotesSession - JavaScript™)

          Read-only. The Domino® URL of a server when HTTP protocols are in effect.

        • International (NotesSession - JavaScript™)

          Read-only. The international (regional) settings for the session's operating environment.

        • IsConvertMIME (NotesSession - JavaScript™)

          Read-Write. Indicates whether items of type NotesItem.MIME_PART are converted to rich text upon NotesDocument instantiation.

        • IsOnServer (NotesSession - JavaScript™)

          Read-only. Indicates whether the session is running on a server.

        • IsRestricted (NotesSession - JavaScript™)

          Read-only. Indicates whether the session is restricted.

        • IsTrackMillisecInJavaDates (NotesSession - JavaScript™)

          Read-Write. Indicates whether milliseconds are used in Java™ dates.

        • IsTrustedSession (NotesSession - JavaScript™)

          Read-only. Indicates whether the session is a trusted session.

        • IsValid (NotesSession - JavaScript™)

          Read-only. Indicates whether an instantiated NotesSession object is still valid.

        • NotesVersion (NotesSession - JavaScript™)

          Read-only. The release of Domino® the session is running on.

        • OrgDirectoryPath (NotesSession - JavaScript™)

          Read-only. The default directory of the current user in a hosted organization.

        • Platform (NotesSession - JavaScript™)

          Read-only. The name of the platform the session is running on.

        • ServerName (NotesSession - JavaScript™)

          Read-only. The full name of the server that the session is running on.

        • UserGroupNameList (NotesSession - JavaScript™)

          Read-only. The groups to which the current user belongs.

        • UserName (NotesSession - JavaScript™)

          Read-only. The full name of the user or server that created the session.

        • UserNameList (NotesSession - JavaScript™)

          Read-only. The name of the user or server that created the session, and the alternate name if it exists.

        • UserNameObject (NotesSession - JavaScript™)

          Read-only. The name, in the form of a NotesName object, of the user or server that created the session.

        • createAdministrationProcess (NotesSession - JavaScript™)

          Creates a new NotesAdministrationProcess object.

        • createColorObject (NotesSession - JavaScript™)

          Creates a new NotesColorObject object.

        • createDateRange (NotesSession - JavaScript™)

          Creates a new NotesDateRange object.

        • createDateTime (NotesSession - JavaScript™)

          Creates a NotesDateTime object that represents a specified date and time.

        • createDxlExporter (NotesSession - JavaScript™)

          Creates a NotesDxlExporter object.

        • createDxlImporter (NotesSession - JavaScript™)

          Creates a NotesDxlImporter object.

        • createLog (NotesSession - JavaScript™)

          Creates a new NotesLog object with the name you specify.

        • createName (NotesSession - JavaScript™)

          Creates a new NotesName object.

        • createNewsletter (NotesSession - JavaScript™)

          Creates a new NotesNewsletter object.

        • createRegistration (NotesSession - JavaScript™)

          Creates a new NotesRegistration object.

        • createRichTextParagraphStyle (NotesSession - JavaScript™)

          Creates a new NotesRichTextParagraphStyle object.

        • createRichTextStyle (NotesSession - JavaScript™)

          Creates a new RichTextStyle object.

        • createStream (NotesSession - JavaScript™)

          Creates a new NotesStream object.

        • evaluate (NotesSession - JavaScript™)

          Evaluates a Domino® formula.

        • freeResourceSearch (NotesSession - JavaScript™)

          Searches for free resource slots for calendaring and scheduling.

        • freeTimeSearch (NotesSession - JavaScript™)

          Searches for free-time slots in the calendar.

        • getCalendar (NotesSession - JavaScript™)

          Creates a new NotesCalendar object.

        • getCredentials (NotesSession - JavaScript™)

          Gets the session's credentials.

        • getCurrentDatabase (NotesSession - JavaScript™)

          Creates a NotesDatabase object that represents the current database and opens the database.

        • getDatabase (NotesSession - JavaScript™)

          Creates a NotesDatabase object that represents the database located at the server and file name you specify, and opens the database, if possible.

        • getDbDirectory (NotesSession - JavaScript™)

          Gets a directory of databases.

        • getDirectory (NotesSession - JavaScript™)

          Creates a new NotesDirectory object using the name of the server you want to access.

        • getEnvironmentString (NotesSession - JavaScript™)

          Gets the value of a string environment variable.

        • getEnvironmentValue (NotesSession - JavaScript™)

          Gets the value of a numeric environment variable.

        • getPropertyBroker (NotesSession - JavaScript™)

          Retrieves the property broker for this session.

        • getSessionToken (NotesSession - JavaScript™)

          Gets a session token for enabling sign-on to Domino® and WebSphere® servers in a domain that supports Single Sign-on.

        • getURL (NotesSession - JavaScript™)

          Gets the Domino® URL for the session.

        • getURLDatabase (NotesSession - JavaScript™)

          Finds and opens the default Web Navigator database.

        • getUserPolicySettings (NotesSession - JavaScript™)

          Gets a policy document.

        • hashPassword (NotesSession - JavaScript™)

          Hashes a string value so that it is not recognizable.

        • resetUserPassword (NotesSession - JavaScript™)

          Sets the password and download count associated with a user's ID file stored in the ID vault. This password is required by the user to recover an ID file from the ID vault.

        • resolve (NotesSession - JavaScript™)

          Returns the Domino® object that a URL addresses.

        • sendConsoleCommand (NotesSession - JavaScript™)

          Sends a console command to a Domino® server.

        • setEnvironmentVar (NotesSession - JavaScript™)

          Sets the value of a string or numeric environment variable.

        • verifyPassword (NotesSession - JavaScript™)

          Verifies a plain string value against a hashed value.

      • 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.

      • 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.

createRichTextStyle (NotesSession - JavaScript™)

Creates a new RichTextStyle object.

Defined in

NotesSession

Syntax

createRichTextStyle() : NotesRichTextStyle
Return value Description
NotesRichTextStyle The newly created NotesRichTextStyle object.

Usage

See the NotesRichTextStyle class for descriptions and examples.
  • Share: Email
  • Twitter
  • Disclaimer
  • Privacy
  • Terms of use
  • Cookie Preferences