Skip to main content

NotesUIWorkspace

Properties

NameDescription
CurrentCalendarDateTimeRead-only. The date and time of the current (the selected) region in a calendar view.
CurrentDatabase (NotesUIWorkspace)Returns a NotesUIDatabase object representing the database that's currently open.
CurrentDocumentReturns a NotesUIDocument object representing the document in the window that currently has focus.
CurrentView (NotesUIWorkspace)Returns a NotesUIView object representing the view that's currently open.
IsEmbeddedInsideWCTRead-only. Indicates whether the applicaton is running in the Workplace Client.
IsInCompositeAppRead-only. Indicates whether the component is running within a composite application.
IsUsingJavaElementRead-only. Indicates whether the current component is a Java-based view or outline.

Methods

NameDescription
AddDatabaseAdds a database to the workspace and highlights the icon, or highlights the icon if the database is already on the workspace.
CheckAlarmsTriggers the alarm daemon to check for new alarms in the mail file.
ComposeDocumentUsing a database and form that you specify, creates a new document and displays it on the workspace.
DialogBoxBrings up a dialog box that displays the current document (either open or selected in a view) or a specified document using a form you specify. The…
EditDocumentOpens the current or a specified document in a mode that you specify.
EditProfileOpens a new or existing Profile document in Edit mode.
EnableAlarmsStarts or stops the alarm daemon.
FolderCopies or moves the current document to a folder.
GetComponentViewPreferenceReturns the value of the specified component view preference.
GetCurrentDatabaseReturns a NotesUIDatabase object representing the database that's currently open.
GetListOfTunesReturns the known sounds on your system.
OpenDatabase (NotesUIWorkspace)Opens a database to a view that you specify.
OpenFileDialogGets file names from the "Open" dialog box.
OpenFrameSetOpens the specified frameset within the current target frame.
OpenPageOpens the specified page within the current target frame.
OutlineReloadReloads a specified outline.
PickListCollectionCreates a NotesDocumentCollection object from a list selected by the user. You specify a view within a database from which the user can select one or…
PickListStringsCreates a string array from a list selected by the user.
PlayTunePlays the specified tune.
PromptDisplays a dialog box and returns a value based on your actions in the dialog box.
RefreshParentNoteUpdates the note with the specified value entered in the dialog box.
ReloadWindowReloads the contents of the current window.
SaveFileDialogGets a file name from the "Save As" dialog box.
SetCurrentLocationSets your current workstation location to the specified location, such as Office, Island, Home, or Travel.
SetTargetFrameAllows you to specify a target frame when opening a view, page, or frameset, or when composing or editing a document.
URLOpenRetrieves a World Wide Web page specified by its URL.
UseLSXLoads a LotusScript® extensions (LSX) file containing Public definitions.
ViewRebuildRebuilds a UI view from its associated back-end view.
ViewRefreshRefreshes a UI view to match its associated back-end view.

Examples

NameDescription
Examples: CurrentDatabase property (NotesUIWorkspace)This example sets the current database property and opens the By Category view.
Examples: CurrentView property (NotesUIWorkspace)This script displays the name of the current view.