Home
HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
LotusScript/COM/OLE Classes
LotusScript® Classes A-Z
This documentation lists each class, property, and method in the Domino® class library. Each class is followed by an alphabetical listing of the properties for that class and an alphabetical listing of the methods for that class. To find the property or method you want, turn to the class to which the property or method belongs.
NotesView (LotusScript®)
Represents a view or folder of a database and provides access to documents within it.
ProtectReaders (NotesView - LotusScript®)
Read-write. Protects $Readers items from being overwritten by replication.

HCL Domino Designer Basic User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in Domino Designer 12?
  The following features are new for developers in HCL Domino® Designer 12.
- Accessibility and keyboard shortcuts
  Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Domino® Query Language
  Domino® Query Language (DQL) is a facility running on a Domino server that provides a terse, shorthand syntax for finding documents. It supports a wide variety and complexity of search terms. It leverages existing design elements, avoiding the need to write detailed code to access them. DQL consolidates all methods in Domino for searching document contents.
- Composite Applications - Design and Management
  Composite applications are a key element in a service-oriented architecture (SOA) and contextual collaboration strategy. The ability to create and edit composite applications lets you easily integrate different types of components and technologies.
- DB2® Access views
  Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
- Programming Overview and User Interface
  This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
- Formula Language
  This section documents the formula language.
- LotusScript® Language
  Welcome to the LotusScript® Language section of Domino® Designer Help.
- LotusScript/COM/OLE Classes
  - LotusScript® Classes Coding Guidelines
    The following topics cover some general guidelines for writing LotusScript® code using Domino® objects:
  - LotusScript® Classes A-Z
    This documentation lists each class, property, and method in the Domino® class library. Each class is followed by an alphabetical listing of the properties for that class and an alphabetical listing of the methods for that class. To find the property or method you want, turn to the class to which the property or method belongs.
    - Properties and methods with ECL security
      The following tables list the properties and methods affected by an Execution Control List (ECL). These properties cannot be accessed or set, and these methods do not execute on the workstation, unless the marked ECL privileges are granted to the signer of the formula.
    - LotusScript® constants
      The following sections provide contextual information for the constants used by the LotusScript® classes. Listed are the constant names, their integer values (in parentheses), and the properties and methods in which they are used.
    - Button (LotusScript®)
      Represents an action, action hotspot, or button on a form or document.
    - Field (LotusScript®)
      Represents a field on a form.
    - Navigator (LotusScript®)
      Represents a navigator button, hotspot, or other navigator object.
    - NotesACL (LotusScript®)
      Represents the access control list (ACL) of a database.
    - NotesACLEntry (LotusScript®)
      Represents a single entry in an access control list. An entry may be for a person, a group, or a server.
    - NotesAdministrationProcess (LotusScript®)
      Represents the administration process.
    - NotesAgent (LotusScript®)
      Represents an agent. The agent may be shared or private, and may be a Release 3 macro.
    - NotesCalendar (LotusScript)
      Represents a Domino® calendar.
    - NotesCalendarEntry (LotusScript)
      Represents a Domino® calendar entry.
    - NotesCalendarNotice (LotusScript)
      Represents a Domino® calendar notice.
    - NotesColorObject (LotusScript®)
      Represents a color.
    - NotesDatabase (LotusScript®)
      Represents a Notes® database.
    - NotesDateRange (LotusScript®)
      Represents a range of dates and times.
    - NotesDateTime (LotusScript®)
      Represents a date and time. Provides a means of translating between the LotusScript® date-time format and the Domino® format.
    - NotesDbDirectory (LotusScript®)
      Represents the Notes® databases on a specific server or local computer.
    - NotesDirectory (LotusScript®)
      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 (LotusScript®)
      Allows lookups of a specific associated Notes® directory on a specific server or local computer.
    - NotesDocument (LotusScript®)
      Represents a document in a database.
    - NotesDocumentCollection (LotusScript®)
      Represents a collection of documents from a database, selected according to specific criteria.
    - NotesDominoQuery (LotusScript®)
      LotusScript® class to compile, tune, and run Domino® Query Language queries.
    - NotesDOMAttributeNode (LotusScript®)
      Represents an attribute in a NotesDOMElementNode object.
    - NotesDOMCDATASectionNode (LotusScript®)
      Represents a CDATA section in the XML data source.
    - NotesDOMCharacterDataNode (LotusScript®)
      Represents character data in a DOM node.
    - NotesDOMCommentNode (LotusScript®)
      Represents a comment in the XML.
    - NotesDOMDocumentFragmentNode (LotusScript®)
      Represents a document fragment in the XML.
    - NotesDOMDocumentNode (LotusScript®)
      Represents the entire XML document. The root of the document tree.
    - NotesDOMDocumentTypeNode (LotusScript®)
      The list of entities that are defined for the document.
    - NotesDOMElementNode (LotusScript®)
      Represents an element in an XML document.
    - NotesDOMEntityNode (LotusScript®)
      Represents an entity node in the XML.
    - NotesDOMEntityReferenceNode (LotusScript®)
      Represents an entity reference node in the XML.
    - NotesDOMNamedNodeMap (LotusScript®)
      Used by methods of the NotesDOMNode class for returning the list of an element node's attributes.
    - NotesDOMNode (LotusScript®)
      Represents a single node in the document tree.
    - NotesDOMNodeList (LotusScript®)
      Used by methods of the NotesDOMNode class for returning the list of an element node's child elements.
    - NotesDOMNotationNode (LotusScript®)
      Represents a notation declared in the DTD.
    - NotesDOMParser (LotusScript®)
      Processes input XML into a standard DOM (Document Object Model) tree structure.
    - NotesDOMProcessingInstructionNode (LotusScript®)
      Represents a processing instruction, used in XML as a way to keep processor-specific information in the text of the document.
    - NotesDOMTextNode (LotusScript®)
      Represents the textual content of an element or attribute.
    - NotesDOMXMLDeclNode (LotusScript®)
      The XML declaration which specifies the version of XML being used.
    - NotesDXLExporter (LotusScript®)
      Represents the conversion of Domino® data to DXL (Domino XML).
    - NotesDXLImporter (LotusScript®)
      Represents the conversion of DXL (Domino® XML) to Domino data.
    - NotesEmbeddedObject (LotusScript®)
      Represents any one of the following:
    - NotesForm (LotusScript®)
      Represents a form in a database.
    - NotesGPS (LotusScript)
      Provides access to user location for supported platforms. Supported for HCL Nomad on iOS and Android V1.0.4 and higher. Supported for HCL Nomad for web browsers V1.0.3 and higher.
    - NotesGPSPosition (LotusScript)
      Represents a position provided by the global positioning device on a platform. Currently supported for HCL Nomad beginning with Release 1.0.4.
    - NotesGPSCoordinates (LotusScript)
      Contains the current coordinates of the position of a device. Currently supported for HCL Nomad beginning with Release 1.0.4.
    - NotesHTTPRequest (LotusScript)
      LotusScript class used to make HTTP requests to web servers.
    - NotesIDVault (LotusScript®)
      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 (LotusScript®)
      Represents the international settings in the operating environment, for example, the Windows™ Control Panel international settings. When any of these settings is changed in the operating environment, Domino® recognizes the new settings immediately.
    - NotesItem (LotusScript®)
      Represents a specific piece of data in a document.
    - NotesJSONArray (LotusScript)
      Represents a JSON array.
    - NotesJSONElement (LotusScript)
      Represents a name, value pair in a JSON string.
    - NotesJSONNavigator (LotusScript)
      LotusScript class used to parse JSON data.
    - NotesJSONObject (LotusScript)
      Represents a JSON object.
    - NotesLog (LotusScript®)
      Enables you to record actions and errors that take place during a script's execution. You can record actions and errors in:
    - NotesMIMEEntity (LotusScript®)
      Represents the MIME (Multipurpose Internet Mail Extensions) content of a document.
    - NotesMIMEHeader (LotusScript®)
      Represents a header in a MIME (Multipurpose Internet Mail Extensions) document.
    - NotesName (LotusScript®)
      Represents a name.
    - NotesNewsletter (LotusScript®)
      A document or set of documents that contain information from, or links to, several other documents.
    - NotesNoteCollection (LotusScript®)
      Represents a collection of Domino® design and data elements in a database.
    - NotesOutline (LotusScript®)
      Represents an outline in a database.
    - NotesOutlineEntry (LotusScript®)
      Represents an entry within an outline. For a detailed explanation of outline and outline entry, see Application Development with Domino® Designer.
    - NotesProperty (LotusScript®)
      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 (LotusScript®)
      Mediates communication between components of a composite application, allowing communication between multiple Notes® components, or between Notes and Java™ components.
    - NotesQueryResultsProcessor (LotusScript)
      Aggregates, computes, sorts, and formats collections of Documents.
    - NotesRegistration (LotusScript®)
      Represents the creation or administration of an ID file.
    - NotesReplication (LotusScript®)
      Represents the replication settings of a database.
    - NotesReplicationEntry (LotusScript®)
      Represents the replication settings for a pair of servers in a database.
    - NotesRichTextDocLink (LotusScript®)
      Represents a doclink in a rich text item.
    - NotesRichTextItem (LotusScript®)
      Represents an item of type rich text.
    - NotesRichTextNavigator (LotusScript®)
      Represents a means of navigation in a rich text item.
    - NotesRichTextParagraphStyle (LotusScript®)
      Represents rich text paragraph attributes.
    - NotesRichTextRange (LotusScript®)
      Represents a range of elements in a rich text item.
    - NotesRichTextSection (LotusScript®)
      Represents a collapsible section in a rich text item.
    - NotesRichTextStyle (LotusScript®)
      Represents rich text attributes.
    - NotesRichTextTab (LotusScript®)
      Represents rich text tab attributes.
    - NotesRichTextTable (LotusScript®)
      Represents a table in a rich text item.
    - NotesSAXAttributeList (LotusScript®)
    - NotesSAXException (LotusScript®)
    - NotesSAXParser (LotusScript®)
      Processes input XML as a series of events using a SAX (Simple API for XML) parser.
    - NotesSession (LotusScript®)
      Represents the environment of the current script, providing access to environment variables, Address Books, information about the current user, and information about the current Notes® platform and release number.
    - NotesStream (LotusScript®)
      Represents a stream of binary or character data.
    - NotesTimer (LotusScript®)
      Represents a mechanism for triggering an event every fixed number of seconds.
    - NotesUIDatabase (LotusScript®)
      Represents the database that's currently open in the Notes® workspace.
    - NotesUIDocument (LotusScript®)
      Represents the document that's currently open in the Notes® workspace.
    - NotesUIScheduler (LotusScript®)
    - NotesUIView (LotusScript®)
      Represents the current view in the Notes® workspace.
    - NotesUIWorkspace (LotusScript®)
      Represents the current Notes® workspace window.
    - NotesUserID (LotusScript®)
      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 (LotusScript®)
      Represents a view or folder of a database and provides access to documents within it.
      - Examples: NotesView class
      - Aliases (NotesView - LotusScript®)
        Read-write. The aliases of a view.
      - AllEntries (NotesView - LotusScript®)
        Read-only. All document entries in a view.
      - AutoUpdate (NotesView - LotusScript®)
        Read-write. Indicates whether a view is automatically refreshed by the currently running code when a navigation method touches an update (addition, deletion, or change) to the database that occurred after view creation or the last refresh.
      - BackgroundColor (NotesView - LotusScript®)
        Read-write. The background color of a view.
      - ColumnCount (NotesView - LotusScript®)
        Read-only. The number of columns in a view.
      - ColumnNames (NotesView - LotusScript®)
        Read-only. The names of the columns in a view.
      - Columns (NotesView - LotusScript®)
        Read-only. All the columns in a view.
      - Created (NotesView - LotusScript®)
        Read-only. The date/time a view was created.
      - EntryCount (NotesView - LotusScript®)
        Read-only. The number of documents in a view.
      - HeaderLines (NotesView - LotusScript®)
        Read-only. The number of lines in the header of a view.
      - HttpURL (NotesView - LotusScript®)
        Read-only. The Domino® URL of a view when HTTP protocols are in effect.
      - IsCalendar (NotesView - LotusScript®)
        Read-only. Indicates whether a view is a calendar view.
      - IsCategorized (NotesView - LotusScript®)
        Read-only. Indicates whether a view is categorized.
      - IsConflict (NotesView - LotusScript®)
        Read-only. Indicates whether a view is enabled for conflict checking.
      - IsDefaultView (NotesView - LotusScript®)
        Read-write. Indicates whether a view is the default view of the database.
      - IsFolder (NotesView - LotusScript®)
        Read-only. Indicates whether a NotesView object represents a folder.
      - IsHierarchical (NotesView - LotusScript®)
        Read-only. Indicates whether a view shows response documents in a hierarchy.
      - IsModified (NotesView - LotusScript®)
        Read-only. Indicates whether a view is modified.
      - IsPrivate (NotesView - LotusScript®)
        Read-only. Indicates whether an entry is specific to an individual.
      - IsProhibitDesignRefresh (NotesView - LotusScript®)
        Read-write. Indicates whether a design refresh or replace can overwrite a view.
      - LastModified (NotesView - LotusScript®)
        Read-only. The date/time a view was last modified.
      - LockHolders (NotesView - LotusScript®)
        Read-only. The names of the holders of a lock.
      - Name (NotesView - LotusScript®)
        Read-write. The name of a view.
      - NotesURL (NotesView - LotusScript®)
        Read-only. The Domino® URL of a view when Notes® protocols are in effect.
      - Parent (NotesView - LotusScript®)
        Read-only. The database to which a view belongs.
      - ProtectReaders (NotesView - LotusScript®)
        Read-write. Protects $Readers items from being overwritten by replication.
        Examples: ProtectReaders property (NotesView - LotusScript®)
        This script toggles protection for the readers field.
      - Readers (NotesView - LotusScript®)
        Read-write. The contents of the $Readers field associated with the view.
      - RowLines (NotesView - LotusScript®)
        Read-only. The number of lines in each row of a view.
      - SelectionFormula (NotesView - LotusScript®)
        Read-write. The selection formula of a view.
      - Spacing (NotesView - LotusScript®)
        Read-write. The spacing between rows of a view.
      - TopLevelEntryCount (NotesView - LotusScript®)
        Read-only. The number of top-level entries in a view.
      - UniversalID (NotesView - LotusScript®)
        Read-only. The Universal ID of a view, which is a 32-character combination of letters and numbers that uniquely identifies a view across all replicas of a database.
      - ViewInheritedName (NotesView - LotusScript®)
        Read-only. The name of the view whose design a view inherits.
      - Clear (NotesView - LotusScript®)
        Clears the full-text search filtering on a view.
      - CopyColumn (NotesView - LotusScript®)
        Creates a new column by copying an existing one.
      - CreateColumn (NotesView - LotusScript®)
        Creates a new column.
      - CreateViewNav (NotesView - LotusScript®)
        Creates a view navigator for all entries in a view.
      - CreateViewNavFrom (NotesView - LotusScript®)
        Creates a view navigator for all entries in a view starting at a specified entry.
      - CreateViewNavFromAllUnread (NotesView - LotusScript®)
        Creates a view navigator for all unread entries in a view.
      - CreateViewNavFromCategory (NotesView - LotusScript®)
        Creates a view navigator for all entries under a specified category.
      - CreateViewNavFromChildren (NotesView - LotusScript®)
        Creates a view navigator for all the immediate children of a specified entry.
      - CreateViewNavFromDescendants (NotesView - LotusScript®)
        Creates a view navigator for all the descendants of a specified entry.
      - CreateViewNavMaxLevel (NotesView - LotusScript®)
        Creates a view navigator for all entries in a view down to a specified level.
      - FTSearch (NotesView - LotusScript®)
        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. This method does not find word variants.
      - FTSearchSorted (NotesView - LotusScript®)
        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 - LotusScript®)
        Finds documents based on their column values within a view. You create an array 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 each key in the array.
      - GetAllEntriesByKey (NotesView - LotusScript®)
        Finds view entries of type document based on their column values within a view. You create an array 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 each key in the array.
      - GetAllReadEntries (NotesView - LotusScript®)
        The method returns all entries associated with documents that have been read.
      - GetAllUnreadEntries (NotesView - LotusScript®)
        The method returns all entries associated with documents that are unread.
      - GetChild (NotesView - LotusScript®)
        Given a document in a view, returns the first response to the document.
      - GetColumn (NotesView - LotusScript®)
        Returns a specified column in a view.
      - GetDocumentByKey (NotesView - LotusScript®)
        Finds a document based on its column values within a view. You create an array of keys, where each key corresponds to a value in a sorted column in the view. The method returns the first document whose column values match each key in the array.
      - GetEntryByKey (NotesView - LotusScript®)
        Finds a view entry of type document based on its column values within a view. You create an array of keys, where each key corresponds to a value in a sorted column in the view. The method returns the first entry whose column values match each key in the array.
      - GetFirstDocument (NotesView - LotusScript®)
        Returns the first document in a view. This is the same document you see when you scroll to the beginning of the view in the Notes® user interface.
      - GetLastDocument (NotesView - LotusScript®)
        Returns the last document in a view. This is the same document you see when you scroll to the end of the view in the Notes® user interface.
      - GetNextDocument (NotesView - LotusScript®)
        Given a document in a view, returns the document immediately following it.
      - GetNextSibling (NotesView - LotusScript®)
        Given a document in a view, returns the document immediately following the given document 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.
      - GetNthDocument (NotesView - LotusScript®)
        Given a number, returns the document at the given position in the top level of a view.
      - GetParentDocument (NotesView - LotusScript®)
        Given a response document in a view, returns its parent document.
      - GetPrevDocument (NotesView - LotusScript®)
        Given a document in a view, returns the document immediately preceding.
      - GetPrevSibling (NotesView - LotusScript®)
        Given a document in a view, returns the document immediately preceding the given document at the same level. If you send the method a main document, the preceding main document in the view is returned. If you send a response document, the preceding response document with the same parent is returned.
      - Lock (NotesView - LotusScript®)
        Locks a view.
      - LockProvisional (NotesView - LotusScript®)
        Locks an view provisionally.
      - MarkAllRead (NotesView - LotusScript®)
        Marks all documents in the view as read.
      - MarkAllUnread (NotesView - LotusScript®)
        Marks all documents in the view as unread.
      - Refresh (NotesView - LotusScript®)
        Updates the view index to reflect any document changes since the NotesView object was created, or since the index was last refreshed.
      - Remove (NotesView - LotusScript®)
        Permanently removes a view from a database.
      - RemoveColumn (NotesView - LotusScript®)
        Removes a column.
      - ResortView (NotesView - LotusScript®)
        Resorts a view.
      - SetAliases (NotesView - LotusScript®)
        Sets the aliases of a view.
      - UnLock (NotesView - LotusScript®)
        Unlocks a view.
    - NotesViewColumn (LotusScript®)
      Represents a column in a view or folder.
    - NotesViewEntry (LotusScript®)
      Represents a view entry. A view entry represents a row in a view.
    - NotesViewEntryCollection class (LotusScript®)
      Represents a collection of view entries, selected according to specific criteria. This class provides you mainly with a collection of documents in a view-sorted order.
    - NotesViewNavigator (LotusScript®)
      Represents a view navigator. A view navigator provides access to all or a subset of the entries in a view.
    - NotesXMLProcessor (LotusScript®)
      A base class containing properties and methods common to all XML processing classes.
    - NotesXSLTransformer (LotusScript®)
      Represents the transformation of DXL (Domino® XML) data through XSLT.
  - LotusScript® Classes Tutorial
    Welcome to LotusScript® and Domino®. "LotusScript Classes Tutorial" consists of three lessons designed to introduce you to using the LotusScript language in Domino. Each lesson includes:
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
- Connectors
  Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
- Javadoc™ for Domino® Designer related APIs
  As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.

ProtectReaders (NotesView - LotusScript®)

Read-write. Protects $Readers items from being overwritten by replication.

Defined in

NotesView

Data type

Boolean

Syntax

To get: flag = notesView .ProtectReaders

To set: notesView .ProtectReaders = flag

Legal values

True indicates that the items are protected.
False indicates that the items are not protected.

Example