rosettajs_dist_lib_rosetta_open.js

"use strict";
/***************************************************
* Licensed Materials - Property of HCL.
* (c)Copyright HCL America, Inc. 2023-2024
****************************************************/
Object.defineProperty(exports, "__esModule", { value: true });
exports._notes = void 0;
exports.openCalendar = openCalendar;
exports.openFrameset = openFrameset;
exports.openHelpDocument = openHelpDocument;
exports.openNavigator = openNavigator;
exports.openPage = openPage;
exports.openDocument = openDocument;
exports.openView = openView;
const tslib_1 = require("tslib");
/**
 * @file Open
 * @module open
 * @category Open
 */
const notesc = tslib_1.__importStar(require("../notes/open"));
exports._notes = notesc;
//-----------------------------
// Notes @Commands open
/**
 * Opens a mail file to the Calendar view.
 * @throws {Error} no plans to implement
 */
function openCalendar() {
    return notesc.OpenCalendar();
}
/**
 * Opens a frameset defined for the current database. Framesets provide a way for
 * designers to display several pages at the same time. A frame is actually one
 * page; a frameset is a collection of pages. Page designers can create links
 * between frames. A major advantage of framesets is the ability to leave one page
 * constant as users scroll or link to other pages.
 * @throws {Error} no plans to implement
 */
function openFrameset() {
    return notesc.OpenFrameset();
}
/**
 * Allows you to create your own context-sensitive help documents. To use this
 * command, you must first create a view that has a sorted first column containing
 * key values that uniquely identify each help document. @Command([OpenHelpDocument])
 * searches this sorted view for the specified key value and, if found, displays
 * the associated help document in a separate Help window.
 * @throws {Error} no plans to implement
 */
function openHelpDocument() {
    return notesc.OpenHelpDocument();
}
/**
 * Opens a navigator defined for the selected database.
 * @throws {Error} no plans to implement
 */
function openNavigator() {
    return notesc.OpenNavigator();
}
/**
 * Opens a page defined for the current database. A page is a design element that
 * structures and displays information, including text, graphics, applets, and
 * links. Unlike a form, a page cannot contain fields, subforms, layout regions,
 * and some embedded controls.
 * @throws {Error} no plans to implement
 */
function openPage() {
    return notesc.OpenPage();
}
/**
 * Opens a document.
 * @returns {Promise<boolean>}
 */
function openDocument(writeOrReadOnly, UNID) {
    return notesc.OpenDocument(writeOrReadOnly, UNID);
}
/**
 * Opens the specified view in the current database.
 * @returns {Promise<boolean>}
 */
function openView(viewName, key) {
    return notesc.OpenView(viewName, key);
}
//# sourceMappingURL=open.js.map