NotesDocument
Properties
| Name | Description |
|---|---|
| Authors | Read-only. The names of the people who have saved a document. |
| ColumnValues (NotesDocument) | Read-only. An array of values, each element of which corresponds to a column value in the document's parent view. The first value in the array is the… |
| Created (NotesDocument) | Read-only. The date/time a document was created. |
| EmbeddedObjects (NotesDocument) | Read-only. The OLE/2 and OLE/1 embedded objects in a document. |
| EncryptionKeys | Read-write. The key(s) used to encrypt a document. The Encrypt method uses these keys when it encrypts the document. |
| EncryptOnSend | Read-write. Indicates whether a document is encrypted when mailed. |
| FolderReferences | Read-only. The names of the folders containing a document. |
| FTSearchScore (NotesDocument) | Read-only. The full-text search score of a document, if it was retrieved as part of a full-text search. |
| HasEmbedded | Read-only. Indicates whether a document contains one or more embedded objects, object links, or file attachments. |
| HttpURL (NotesDocument) | Read-only. The Domino® URL of a document when HTTP protocols are in effect. |
| IsDeleted | Read-only. Indicates whether a Document object represents an existing document (not a deletion stub) on an ongoing basis. |
| IsEncrypted (NotesDocument) | Read-only. Indicates whether a document is encrypted. |
| IsNamedDoc | Indicates whether a document is a named document. |
| IsNewNote | Read-only. Indicates whether a document is new. A document is new if it hasn't been saved. |
| IsProfile | Read-only. Indicates whether a NotesDocument object is a Profile document. |
| IsResponse (NotesDocument) | Read-only. Indicates whether a document is a response to another document. |
| IsSigned (NotesDocument) | Read-only. Indicates whether a document contains a signature. |
| IsUIDocOpen | Read-only. Indicates whether a NotesDocument object (back-end document) is accessed through a NotesUIDocument object (front-end document). |
| IsValid (NotesDocument) | Read-only. Indicates whether a Document object represents an existing document (not a deletion stub) initially. |
| Items | Read-only. All the items in a document. An item is any piece of data stored in a document. |
| Key | Read-only. If a Profile document, the user name (key) of the profile. |
| LastAccessed | Read-only. The date/time a document was last modified or read. |
| LastModified (NotesDocument) | Read-only. The date/time a document was last modified. |
| LockHolders (NotesDocument) | Read-only. The names of the holders of a lock. |
| NameOfDoc | Returns the name of a named document. |
| NameOfProfile | Read-only. If a Profile document, the name of the profile. |
| NoteID (NotesDocument) | Read-only. The note ID of a document, which is an 8-character combination of letters and numbers that uniquely identifies a document within a particular… |
| NotesURL (NotesDocument) | Read-only. The Domino® URL of a document when Notes® protocols are in effect. |
| ParentDatabase (NotesDocument) | Read-only. The database that contains a document. |
| ParentDocumentUNID | 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) | Read-only. The view from which a document was retrieved, if any. |
| Responses | Read-only. The immediate responses to a document. |
| SaveMessageOnSend | Read-write. Indicates whether a document is saved to a database when mailed. Only applies to new documents that have not yet been saved. |
| SentByAgent | Read-only. Indicates whether a document was mailed by a script. |
| Signer | Read-only. The name of the person who created the signature, if a document is signed. |
| SignOnSend | Read-write. Indicates whether a document is signed when mailed. |
| Size (NotesDocument) | Read-only. The size of a document in bytes, which includes the size of any file attachments on the document. |
| UniversalID (NotesDocument) | Read-write. The universal ID, which uniquely identifies a document across all replicas of a database. In character format, the universal ID is a… |
| UserNameOfDoc | Returns a user name associated with a named document. |
| Verifier | Read-only. The name of the certificate that verified a signature, if a document is signed. |
Methods
| Name | Description |
|---|---|
| AppendItemValue | Creates a new item in a document and sets the item value. |
| AttachVCard | Attaches one or more documents in vCard format. |
| CloseMIMEEntities | Closes MIME processing associated with items of a specified name. |
| ComputeWithForm | Validates a document by executing the default value, translation, and validation formulas, if any are defined in the document form. |
| ConvertToMIME | Converts a document in Notes® format to MIME format similar to a mail router. |
| CopyAllItems | Given a destination document, copies all of the items in the current document into the destination document. The item names are unchanged. |
| CopyItem | Given an item, copies it into the current document and optionally assigns the copied item a new name. |
| CopyToDatabase | Copies a document into the specified database. |
| CreateMIMEEntity | Creates an uninitialized top-level MIME entity in a document. |
| CreateReplyMessage | Creates a new document that is formatted as a reply to the current document. |
| CreateRichTextItem | Creates a new rich text item in a document, using a name you specify, and returns the corresponding NotesRichTextItem object. When used with OLE… |
| Encrypt (NotesDocument) | Encrypts a document in a database. |
| GetAttachment | Given the name of a file attachment, returns a NotesEmbeddedObject representing the attachment. You can use this method to find file attachments which… |
| GetFirstItem | Given a name, returns the first item of the specified name belonging to the document. |
| GetItemValue | Given the name of an item, returns the value of that item in a document. |
| GetItemValueCustomDataBytes | Returns as a byte array the value of an item containing custom data. |
| GetItemValueDateTimeArray | Returns the value of a date-time item in a document. |
| GetMIMEEntity (NotesDocument) | Gets a top-level MIME entity. |
| GetRead (NotesDocument) | Returns true if the current document has been read, otherwise false. |
| GetReceivedItemText | Gets the text values of the Received items in a mail document. |
| HasItem | Given the name of an item, indicates whether that item exists on the document. |
| Lock (NotesDocument) | Locks a document. |
| LockProvisional (NotesDocument) | Locks a document provisionally. |
| MakeResponse | Makes one document a response to another document. The two documents must be in the same database. |
| PutInFolder | Adds a document to the specified folder. If the folder does not exist in the document's database, it is created. |
| Remove (NotesDocument) | Permanently deletes a document from a database, but does a soft deletion if soft deletions are enabled. |
| RemoveFromFolder | Removes a document from the specified folder. |
| RemoveItem | Given the name of an item, deletes the item from a document. |
| RemovePermanently | Permanently deletes a document from a database, doing a hard deletion even if soft deletions are enabled. |
| RenderToRTItem | Creates a picture of a document and places it into a rich text item you specify. The picture is created using both the document and its form. Therefore,… |
| ReplaceItemValue | Replaces all items of the specified name with one new item, which is assigned the specified value. If the document does not contain an item with the… |
| ReplaceItemValueCustomDataBytes | 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… |
| Save (NotesDocument) | Saves any changes you have made to a document. |
| Send (NotesDocument) | Mails a document. |
| Sign (NotesDocument) | Signs a document. |
| UnLock (NotesDocument) | Unlocks a document. |
Examples
| Name | Description |
|---|---|
| Examples: ColumnValues property (NotesDocument) | 1. You retrieve a document called currentDoc from a view that has two columns: the first shows the due date of a project (its column formula is the field… |
| Examples: Created property (NotesDocument) | 1. If the last document in the Main View of the current database was created on February 7, 1995 at 10:17:16 A.M., this script prints "2/7/95 10:17:16 AM." |
| Examples: EmbeddedObjects property (NotesDocument) | This script uses the EmbeddedObjects property in NotesDocument. The last document in the All Documents view of HILL.NSF contains the following: |
| Examples: FolderReferences property | The following script creates a new document in the database, puts it into view1, view2, and view3 folders, then prints out all folder references and a… |
| Examples: FTSearchScore property (NotesDocument) | 1. This script performs a full-text search to filter the By Category view of the current database. It then gets the full-text search score of the first… |
| Examples: GetMIMEEntity method (NotesDocument) | This agent gets the MIME content from an item. |
| Examples: IsEncrypted property (NotesDocument) | This agent displays whether the current document is encrypted. |
| Examples: IsNewNote property | This script prints a message. |
| Examples: IsProfile property | This example displays the properties of a Profile document. |
| Examples: IsResponse property (NotesDocument) | This script checks if a document is a response. |
| Examples: IsSigned property (NotesDocument) | This script checks if a document is signed. |
| Examples: IsValid property (NotesDocument) | This example retrieves a document, then it checks to see whether or not the document is valid. |
| Examples: LastModified property (NotesDocument) | 1. This script gets the date that a document was last modified and puts it into modifyDate. For example, LastModified returns 10/31/95 10:42:31 AM. |
| Examples: Lock method (NotesDocument) | This view action attempts to lock the current document for all members of the "Guys" group. Locking is successful if the document is not yet locked, or… |
| Examples: LockHolders property (NotesDocument) | This view action displays the lock holders for the current document. |
| Examples: LockProvisional method (NotesDocument) | This view action attempts to lock the current document for all members of the "Guys" group. Locking is successful if the document is not yet locked, or… |
| Examples: NoteID property (NotesDocument) | This script gets the note ID of doc and places it into the nid variable. |
| Examples: Remove method (NotesDocument) | 1. This script removes a document from a database, unless another user has modified it. |
| Examples: Save method (NotesDocument) | 1. This script creates and saves a new document in the current database. Because the document is new, there is no chance of conflicting edits, so the… |
| Examples: Size property (NotesDocument) | This script gets the size of a document and puts it into sizeInBytes. For example, Size returns 135. |
| Examples: UniversalID property (NotesDocument) | This agent creates a new document with a universal ID based on the agent comment. |
| Examples: UnLock method (NotesDocument) | This view action attempts to unlock the current document. Unlocking is successful if the effective user is one of the lock holders. |
Reference
| Name | Description |
|---|---|
| MarkRead | Marks the document as read. |
| MarkUnread | Marks the document as unread. |