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.
NotesDocument (JavaScript™)
Represents a document in a database.
Size (NotesDocument - JavaScript™)
Read-only. The size of a document in bytes, which includes the size of any file attachments to the document.

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.
    - Authors (NotesDocument - JavaScript™)
      Read-only. The names of the people who have saved a document.
    - ColumnValues (NotesDocument - JavaScript™)
      Read-only. A vector of values, each element of which corresponds to a column value in the document's parent view.
    - Created (NotesDocument - JavaScript™)
      Read-only. The date/time a document was created.
    - EmbeddedObjects (NotesDocument - JavaScript™)
      Read-only. The OLE/2 and OLE/1 embedded objects in a document.
    - EncryptionKeys (NotesDocument - JavaScript™)
      Read-Write. The key(s) used to encrypt a document.
    - FolderReferences (NotesDocument - JavaScript™)
      Read-only. The names of the folders containing a document.
    - FTSearchScore (NotesDocument - JavaScript™)
      Read-only. The full-text search score of a document, if it was retrieved as part of a full-text search.
    - HasEmbedded (NotesDocument - JavaScript™)
      Read-only. Indicates whether a document contains one or more embedded objects, object links, or file attachments.
    - HttpURL (NotesDocument - JavaScript™)
      Read-only. The Domino® URL of a document when HTTP protocols are in effect.
    - InitiallyModified (NotesDocument - JavaScript™)
      Read-only. The date/time a document was initially modified.
    - IsDeleted (NotesDocument - JavaScript™)
      Read-only. Indicates whether a NotesDocument object represents an existing document (not a deletion stub) on an ongoing basis.
    - IsEncrypted (NotesDocument - JavaScript™)
      Read-only. Indicates whether a document is encrypted.
    - IsEncryptOnSend (NotesDocument - JavaScript™)
      Read-Write. Indicates whether a document is encrypted when mailed.
    - IsNewNote (NotesDocument - JavaScript™)
      Read-only. Indicates whether a document is new.
    - isPreferJavaDates setPreferJavaDates (NotesDocument - JavaScript™)
      Indicates whether Java™ dates are preferred.
    - IsProfile (NotesDocument - JavaScript™)
      Read-only. Indicates whether a NotesDocument object is a profile document.
    - IsResponse (NotesDocument - JavaScript™)
      Read-only. Indicates whether a document is a response to another document.
    - IsSaveMessageOnSend (NotesDocument - JavaScript™)
      Read-Write. Indicates whether a document is saved to a database when mailed.
    - IsSentByAgent (NotesDocument - JavaScript™)
      Read-only. Indicates whether a document was mailed by a Domino® program.
    - IsSigned (NotesDocument - JavaScript™)
      Read-only. Indicates whether a document contains a signature.
    - IsSignOnSend (NotesDocument - JavaScript™)
      Read-Write. Indicates whether a document is signed when mailed.
    - IsValid (NotesDocument - JavaScript™)
      Read-only. Indicates whether a Document object represents an existing document (not a deletion stub) initially.
    - Items (NotesDocument - JavaScript™)
      Read-only. All the items in a document. An item is any piece of data stored in a document.
    - Key (NotesDocument - JavaScript™)
      Read-only. If a profile document, the user name (key) of the profile.
    - LastAccessed (NotesDocument - JavaScript™)
      Read-only. The date/time a document was last modified or read.
    - LastModified (NotesDocument - JavaScript™)
      Read-only. The date/time a document was last modified.
    - LockHolders (NotesDocument - JavaScript™)
      Read-only. The names of the holders of a lock.
    - NameOfProfile (NotesDocument - JavaScript™)
      Read-only. If a profile document, the name of the profile.
    - NoteID (NotesDocument - JavaScript™)
      Read-only. The note ID of a document, which is a hexadecimal value of up to 8 characters that uniquely identifies a document within a particular database.
    - NotesURL (NotesDocument - JavaScript™)
      Read-only. The Domino® URL of a document when Notes® protocols are in effect.
    - ParentDatabase (NotesDocument - JavaScript™)
      Read-only. The database that contains a document.
    - ParentDocumentUNID (NotesDocument - JavaScript™)
      Read-only. The universal ID of a document's parent, if the document is a response. Returns an empty string if a document doesn't have a parent.
    - ParentView (NotesDocument - JavaScript™)
      Read-only. The view from which a document was retrieved, if any.
    - Responses (NotesDocument - JavaScript™)
      Read-only. The immediate responses to a document.
    - Signer (NotesDocument - JavaScript™)
      Read-only. The name of the person who created the signature, if a document is signed.
    - Size (NotesDocument - JavaScript™)
      Read-only. The size of a document in bytes, which includes the size of any file attachments to the document.
    - UniversalID (NotesDocument - JavaScript™)
      Read-Write. The universal ID, which uniquely identifies a document across all replicas of a database.
    - Verifier (NotesDocument - JavaScript™)
      Read-only. The name of the certificate that verified a signature, if a document is signed.
    - appendItemValue (NotesDocument - JavaScript™)
      Creates a new item in a document and optionally sets the item value.
    - attachVCard (NotesDocument - JavaScript™)
      Attaches one or more documents in vCard format.
    - closeMIMEEntities (NotesDocument - JavaScript™)
      Closes MIME processing associated with items of a specified name.
    - computeWithForm (NotesDocument - JavaScript™)
      Validates a document by executing default value, translation, and validation formulas, if any are defined in the document form.
    - convertToMIME (NotesDocument - JavaScript™)
      Converts a document in Notes® format to MIME format similar to a mail router.
    - copyAllItems (NotesDocument - JavaScript™)
      Copies all items in the current document into the destination document.
    - copyItem (NotesDocument - JavaScript™)
      Copies an item into the current document and optionally assigns the copied item a new name.
    - copyToDatabase (NotesDocument - JavaScript™)
      Copies a document to a specified database.
    - createMIMEEntity (NotesDocument - JavaScript™)
      Creates an uninitialized top-level MIME entity in a document.
    - createReplyMessage (NotesDocument - JavaScript™)
      Creates a new document that is formatted as a reply to the current document.
    - createRichTextItem (NotesDocument - JavaScript™)
      Creates a new rich-text item in a document.
    - encrypt (NotesDocument - JavaScript™)
      Encrypts a document.
    - generateXML (NotesDocument - JavaScript™)
      Generates an XML representation of a document to the Writer. The XML conforms to the Domino® Document DTD.
    - getAttachment (NotesDocument - JavaScript™)
      Returns a representation of a file attachment.
    - getFirstItem (NotesDocument - JavaScript™)
      Returns the first item of a specified name in a document.
    - getItemValue (NotesDocument - JavaScript™)
      Returns the value of an item.
    - getItemValueCustomData (NotesDocument - JavaScript™)
      Returns as an object the value of an item containing custom data.
    - getItemValueCustomDataBytes (NotesDocument - JavaScript™)
      Returns as a byte array the value of an item containing custom data.
    - getItemValueDateTimeArray (NotesDocument - JavaScript™)
      Returns the value of a date-time item in a document.
    - getItemValueDouble (NotesDocument - JavaScript™)
      Returns the value of an item with a single numeric value.
    - getItemValueInteger (NotesDocument - JavaScript™)
      Returns the integer value of an item with a single numeric value.
    - getItemValueString (NotesDocument - JavaScript™)
      Returns the value of an item with a single text value.
    - getMIMEEntity (NotesDocument - JavaScript™)
      Gets a top-level MIME entity.
    - getRead (NotesDocument - JavaScript™)
      Returns whether a document was read by a user.
    - getReceivedItemText (NotesDocument - JavaScript™)
      Gets the text values of the received items in a mail document.
    - getURL (NotesDocument - JavaScript™)
      Gets the Domino® URL for the document.
    - hasItem (NotesDocument - JavaScript™)
      Indicates whether an item exists in the document.
    - lock (NotesDocument - JavaScript™)
      Locks a document.
    - lockProvisional (NotesDocument - JavaScript™)
      Locks a document provisionally.
    - makeResponse (NotesDocument - JavaScript™)
      Makes one document a response to another.
    - markRead (NotesDocument - JavaScript™)
      Marks a document as read.
    - markUnread (NotesDocument - JavaScript™)
      Marks the document as unread.
    - putInFolder (NotesDocument - JavaScript™)
      Adds a document to a folder.
    - remove (NotesDocument - JavaScript™)
      Deletes a document from a database, doing a soft deletion if soft deletions are enabled and a hard deletion otherwise.
    - removeFromFolder (NotesDocument - JavaScript™)
      Removes a document from a folder.
    - removeItem (NotesDocument - JavaScript™)
      Removes an item from a document.
    - removePermanently (NotesDocument - JavaScript™)
      Permanently deletes a document from a database, doing a hard deletion even if soft deletions are enabled.
    - renderToRTItem (NotesDocument - JavaScript™)
      Creates a picture of a document and places it into a rich-text item that you specify.
    - replaceItemValue (NotesDocument - JavaScript™)
      Replaces all items of the specified name with one new item, which is assigned the specified value.
    - replaceItemValueCustomData (NotesDocument - JavaScript™)
      Replaces all items of the specified name with one new item, which is assigned custom data from an object. If the document does not contain an item with the specified name, this method creates a new item and adds it to the document.
    - replaceItemValueCustomDataBytes (NotesDocument - JavaScript™)
      Replaces all items of the specified name with one new item, which is assigned custom data from a byte array. If the document does not contain an item with the specified name, this method creates a new item and adds it to the document.
    - save (NotesDocument - JavaScript™)
      Saves any changes you have made to a document.
    - send (NotesDocument - JavaScript™)
      Mails a document.
    - sign (NotesDocument - JavaScript™)
      Signs a document.
    - unlock (NotesDocument - JavaScript™)
      Unlocks a document.
  - 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.
  - 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.

Size (NotesDocument - JavaScript™)

Read-only. The size of a document in bytes, which includes the size of any file attachments to the document.

Defined in

NotesDocument

Syntax

getSize() : int

Examples

This computed field displays the number of bytes in the current document.

var doc:NotesDocument = currentDocument.getDocument();
return "The current document uses " + doc.getSize().toFixed() + " bytes"