Domino LotusScript Classes

The article was added by David P. Stateson at 03/06/2008.

 Home | Submit article | About us | Contact us
Other Application articles

You are here: Categories » Technology and Computer » Application

Domino LotusScript Classes

Domino LotusScript classes are classified into two categories, front-end and back-end classes. Front-end classes, also known as UI (user interface) classes, represent objects visible to the user on the screen, such as workspace, database, or navigator. Back-end classes, in contrast, are used to manipulate objects that are not visible to the user on the screen. For example, the NotesDatabase class represents a Notes database, which may or may not be the one on which the user is currently working.

Front-End Classes

As already mentioned, front-end classes represent objects visible to the user on the screen, with which a user can directly interact. The following sections comprise a list of front-end classes in LotusScript.

Button

The Button class is used to access the Click event associated with buttons, actions, and hotspots on forms and pages. This class does not contain any properties or methods.

Field

The Field class is used to access Entering and Exiting events for the fields in a form. This class does not contain any properties or methods.

Navigator

ads1
ads2

The Navigator class is used to access a navigator object in a database. This class also does not contain any properties or methods.

NotesUIDatabase

The NotesUIDatabase class, contained in the NotesUIWorkspace class, is used to access a database that is currently open in the Notes workspace. This class contains NotesDatabase and NotesDocumentCollection classes.

NotesUIDocument

The NotesUIDocument class, contained in the NotesUIWorkspace class, is used to access the currently opened document in the workspace. This class contains NotesDocument and NotesUIScheduler classes.

NotesUIScheduler

The NotesUIScheduler class, contained by the NotesUIDocument class, is used to access the embedded scheduler in a document. This class contains NotesDateRange and NotesDateTime classes.

NotesUIView

The NotesUIView class, contained in the NotesUIWorkspace class, is used to access the currently opened view in the Notes workspace. This class contains NotesDocumentCollection and NotesUIView classes.

NotesUIWorkspace

The NotesUIWorkspace class is used to access the current Notes workspace. This class contains NotesUIDatabase, NotesUIDocument, and NotesUIView classes.

Back-End Classes

Back-end classes are used to manipulate Domino objects that are not directly accessible to the user. These classes may be used to access any Domino object without user intervention.

NotesACL

The NotesACL class, contained in the NotesDatabase class, is used to access the ACL (Access Control List) of a database. This class contains the NotesACLEntry class.

NotesACLEntry

The NotesACLEntry class, contained in the NotesACL class, is used to access an individual entry in the ACL.

NotesAgent

The NotesAgent class is used to access an agent. This class is contained in NotesSession and NotesDatabase classes.

NotesColorObject

The NotesColorObject class represents a color and is used to dynamically set the color of objects, such as a view background or the font color of a view column. This class is contained in NotesSession, NotesRichTextSection, and NotesRichTextTable classes.

NotesDatabase

The NotesDatabase class, contained in NotesSession, NotesDbDirectory, and NotesUIDatabase classes, is used to access a Notes database.

The class contains the following classes:

  • NotesACL

  • NotesAgent

  • NotesDocument

  • NotesDocumentCollection

  • NotesForm

  • NotesOutline

  • NotesReplication

  • NotesView

NotesDateRange

The NotesDateRange class, contained in NotesSession and NotesUIScheduler classes, is used to access a range of date and time. The class contains the NotesDateTime class.

NotesDateTime

The NotesDateTime class, contained in NotesDateRange and NotesSession classes, is used to access date and time. This class is used to translate between the Domino date/time format and the LotusScript date/time format.

NotesDbDirectory

The NotesDbDirectory class, contained in the NotesSession class, is used to access the databases on a specific server or the local computer. This class contains the NotesDatabase class.

NotesDocument

The NotesDocument class is used to access a document within a database. This class contains NotesEmbeddedObject, NotesItem, NotesMIMEEntity, and NotesRichTextItem classes and is contained in the following classes:

  • NotesDatabase

  • ads4

    NotesDocumentCollection

  • NotesNewsletter

  • NotesUIDocument

  • NotesView

  • NotesViewEntry

NotesDocumentCollection

The NotesDocumentCollection class is used to access a set of documents that is selected on the basis of specified criteria.

This class contains the NotesDocument class and is contained in the following classes:

  • NotesDatabase

  • NotesSession

  • NotesUIDatabase

  • NotesUIView

NotesEmbeddedObject

The NotesEmbeddedObject class is used to access an embedded object, a linked object, or a file attachment in a document. The class is contained in the NotesDocument and NotesRichTextItem classes.

NotesForm

The NotesForm class is used to access a form in a database. The class is contained in the NotesDatabase class.

NotesInternational

The NotesInternational class is used to access the international settings (specified in the Control Panel) on a computer. For example, you can access the date and time format or the currency format for an individual computer's operating environment. This class is contained in the NotesSession class.

NotesItem

The NotesItem class is used to access a specific data item within a document. For example, this class can be used to access a field in a document displayed in the UI. This class is contained in the NotesDocument class and is the base class for the NotesRichTextItem class.

NotesLog

The NotesLog class, contained by the NotesSession class, is used to record information about the execution of a script, such as the actions performed or error messages. You can record this information in a database, a mail memo, a file, or an agent log.

NotesMIMEEntity

The NotesMIMEEntity class is used to access the MIME (Multipurpose Internet Mail Extensions) content of a document. This class is contained in NotesItem and is the base class for NotesMIMEHeader.

NotesMIMEHeader

The NotesMIMEHeader class represents the header in a MIME document. This class is contained in the NotesMIMEEntity class.

NotesName

The NotesName class is used to access a user or server name. This class is contained in the NotesSession class.

NotesNewsletter

The NotesNewsletter class is used to format a document that contains links to a set of documents that satisfy the specified criteria. The class is contained in NotesSession and is the base class for NotesDocument.

NotesNoteCollection

The NotesNoteCollection class represents a collection of data and design elements in a database. This class is contained in NotesDatabase.

NotesOutline

The NotesOutline class is used to access an outline. The class is contained in NotesDatabase and contains NotesOutlineEntry.

NotesOutlineEntry

The NotesOutlineEntry class is used to access one of the entries within an outline. The class is contained in the NotesOutline class.

NotesRegistration

The NotesRegistration class is used to create or administer an ID file. The class is contained in NotesSession.

NotesReplication

The NotesReplication class is used to access the replication settings for a database. The class is contained in NotesDatabase.

NotesRichTextItem

The NotesRichTextItem class, contained in the NotesDocument class, is used to access a rich text data type item in a Notes document. The class is derived from the NotesItem class and contains NotesEmbeddedObject.

NotesRichTextDocLink

The NotesRichTextDocLink class is used to access a doclink in a rich text item. This class is contained in NotesRichTextItem and NotesRichTextNavigator and contains NotesRichTextStyle.

NotesRichTextNavigator

The NotesRichTextNavigator class is used to navigate in a rich text item. This class is contained in NotesRichTextItem and contains NotesRichTextSection, NotesRichTextTable, and NotesRichTextDocLink classes.

NotesRichTextParagraphStyle

The NotesRichTextParagraphStyle class is used to access text paragraph attributes, such as spacing, margins, and the alignment of a rich text item. The class is contained in NotesSession and contains NotesRichTextTab.

NotesRichTextRange

The NotesRichTextRange class is used to access the elements in a rich text item sequentially. This class is contained in NotesRichTextItem and contains NotesRichTextStyle.

NotesRichTextSection

The NotesRichTextSection class is used to access a collapsible section in a rich text item. This class is contained in NotesRichTextNavigator and contains NotesColorObject and NotesRichTextStyle classes.

NotesRichTextTab

The NotesRichTextTab class is used to access the tab attributes of a rich text item. This class is contained in NotesRichTextParagraphStyle.

NotesRichTextTable

The NotesRichTextTable class is used to access a table in a rich text item. This class is contained in NotesRichTextItem and NotesRichTextNavigator and contains NotesColorObject.

NotesRichTextStyle

The NotesRichTextStyle class is used to access the style attributes, such as font, font size, and font color, and effects of a rich text item.

This class is contained in the following classes:

  • NotesRichTextDocLink

  • NotesRichTextNavigator

  • NotesRichTextRange

  • NotesRichTextSection

  • NotesSession

NotesSession

The NotesSession class is used to access the current environment, and it provides access to environment variables, information about the current user, information about the current Notes version and platform, and address books.

The NotesSession class contains the following classes:

  • NotesAgent

  • NotesColorObject

  • NotesDatabase

  • NotesDateRange

  • NotesDateTime

  • NotesDbDirectory

  • NotesDocument

  • NotesDocumentCollection

  • NotesInternational

  • NotesName

  • NotesLog

  • NotesNewsletter

  • NotesRegistration

  • NotesRichTextParagraphStyle

  • NotesRichTextStyle

  • NotesStream

  • NotesTimer

NotesStream

The NotesStream class represents a stream of binary or character data. This class is contained in NotesSession.

NotesTimer

The NotesTimer class is used to trigger an event at a specific time. The class is contained in NotesSession.

NotesView

The NotesView class is used to access a view or folder in a database. The class is contained in NotesDatabase and NotesUIView classes and contains the following classes:

  • NotesDocument

  • NotesViewColumn

  • NotesViewEntry

  • NotesViewEntryCollection

  • NotesViewNavigator

NotesViewColumn

The NotesViewColumn class is used to access a column in a view. This class is contained in NotesView.

NotesViewEntry

The NotesViewEntry class is used to access a specified row in a view. This class contains the NotesDocument class and is contained in the following classes:

  • NotesView

  • NotesViewEntryCollection

  • NotesViewNavigator

NotesViewEntryCollection

The NotesViewEntryCollection class is used to access a collection of view entries selected according to specific criteria. The class is contained in NotesView and contains NotesViewEntry.

NotesViewNavigator

The NotesViewNavigator class is used to access all or a subset of the entries in a view. This class is contained in NotesView and NotesViewEntry.

Application Disclaimer

  • The Soft articles directory team is not responsible for falsehoods, inaccuracies, or any other types of misinformation this article may contain and will not be liable for any damage or loss suffered by a user through the user's reliance on the information gained here.
  • Soft Articles Directory is not responsible for any and all copyright infringements by writers and authors. If you suspect the information contained by this page for any copyright infringements, please contact us and we'll investigate the issue.
Creating Newsletters with Lotus Notes R6 - ...te the newsletter. This summary can be presented in two ways, as a snapshot of the document in picture format or as document links to the documents that form the newsletter itself. An example of a...
Collaborative Applications - ...oughts and ideas. Because of this, these applications are considered complementary to each other. While messaging achieves one-to-one communication, reference and broadcasting applications...
A Collaborative Discussion Application - ... It will reduce the cost of communication. It will provide convenience across time zones for participation in discussions. It will be possible to ...
Types of Notes Applications - ...tions Workflow applications Reference applications are usually used to manage online reference material. Broadcast applications are used to del...
Types of Domino Applications - ...follows: Workflow. This type of application allows users to communicate, collaborate, and coordinate business activities. Some common examples of workflow applicat...
 
free content
    Copyright © 2007-2008 Soft Articles Directory. Designed by the Soft Article Directory Team.
The articles and tutorials in the directory are property of their respective owners and authors.