FolderReferences (NotesDocument - JavaScript™)

Read-only. The names of the folders containing a document.

Defined in

NotesDocument

Syntax

getFolderReferences() : java.util.Vector

Usage

The database must have the $FolderInfo and $FolderRefInfo hidden views to support folder references. These views can be copied from the mail template. This property does not return view references.

Folder references must be enabled for the database. See the FolderReferencesEnabled property of NotesDatabase.

Examples

This computed field displays the folders in which the current document resides. The XPage is in a database based on the mail template.
database.setFolderReferencesEnabled(true); // make sure folder references are enabled
var doc:NotesDocument = currentDocument.getDocument();
var folders = doc.getFolderReferences();
if (folders.isEmpty()) {
	return "Not in any folders";
}
var msg = "In these folders:";
var foldersi = folders.iterator();
while (foldersi.hasNext()) {
	if (msg.endsWith(":")) {
		msg = msg + " ";
	} else {
		msg = msg + "; ";
	}
	msg = msg + foldersi.next();
}
return msg;