rosettajs_dist_lib_rosetta_create.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.compose = compose;
exports.composeWithReference = composeWithReference;
exports.createAction = createAction;
exports.createAgent = createAgent;
exports.createControlledAccessSection = createControlledAccessSection;
exports.createEllipse = createEllipse;
exports.createFolder = createFolder;
exports.createForm = createForm;
exports.createLayoutRegion = createLayoutRegion;
exports.createNavigator = createNavigator;
exports.createPolygon = createPolygon;
exports.createPolyline = createPolyline;
exports.createRectangle = createRectangle;
exports.createRectangularHotspot = createRectangularHotspot;
exports.createSection = createSection;
exports.createSubform = createSubform;
exports.createTextbox = createTextbox;
exports.createView = createView;
const tslib_1 = require("tslib");
/**
 * @file Create
 * @module create
 * @category Create
 */
const notesc = tslib_1.__importStar(require("../notes/create"));
exports._notes = notesc;
//-----------------------------
// Notes @Commands create
/**
 * Compose will make an empty document and then set it as the current document
 * The database must be open using fileOpenDatabase to compose a new document.
 * The document can be saved to the server using FileSave()
 * Composed documents not saved to the server are lost when the app closes.
 * @param {*} serverDatabase The name of the server and database where you want to create the document. For VoltMX, this is the name of the object service. For DRAPI, this is the name of the scope.
 * @param {string} formName The name of the form you want to use when creating the new document.
 * @see For further information, see {@link https://help.hcltechsw.com/dom_designer/14.0.0/basic/H_COMPOSE.html | hcltechsw.com}
 * @returns {boolean} True if the document was composed. False if an error occurred trying to compose the document.
 * @example
 * REM "Composes a new MainTopic document in the current database";
 * @Command([Compose]; ""; "MainTopic")
 */
function compose(serverDatabase, form) {
    return notesc.Compose(serverDatabase, form);
}
/**
 * Creates a new document filling in the Body rich text field with values based on the current document.
 * @throws {Error} no plans to implement
 */
function composeWithReference() {
    return notesc.ComposeWithReference();
}
/**
 * Creates a new action and opens the design pane, where you can edit the action.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createAction() {
    return notesc.CreateAction();
}
/**
 * Creates a new agent in the current database and opens the Agent Properties box,
 * where you can name and define the agent.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createAgent() {
    return notesc.CreateAgent();
}
/**
 * Creates a controlled access section on a form or subform. Unlike a regular
 * section, a controlled access section has a formula to determine who can edit it.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createControlledAccessSection() {
    return notesc.CreateControlledAccessSection();
}
/**
 * Lets you create an ellipse in a navigator. After you invoke the command, the
 * cursor changes to a crosshair when you start to drag the mouse in the design
 * area. You create an ellipse by dragging the mouse until the ellipse is the size
 * you want.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createEllipse() {
    return notesc.CreateEllipse();
}
/**
 * Displays the Create Folder dialog box, which lets you choose a location for a
 * new folder and create it.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createFolder() {
    return notesc.CreateFolder();
}
/**
 * Creates a new, blank form in a database.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createForm() {
    return notesc.CreateForm();
}
/**
 * Creates a new layout region on a form or subform.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createLayoutRegion() {
    return notesc.CreateLayoutRegion();
}
/**
 * Creates a new, blank navigator in a database.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createNavigator() {
    return notesc.CreateNavigator();
}
/**
 * Lets you create a polygon in a navigator. After you invoke the command, the
 * cursor changes to a crosshair when you start to drag the mouse in the design
 * area. You create a polygon by clicking the mouse each time you want to start
 * a new side. Double-click when you are done.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createPolygon() {
    return notesc.CreatePolygon();
}
/**
 * Lets you create a polyline in a navigator. After you invoke the command, the
 * cursor changes to a crosshair when you start to drag the mouse in the design
 * area. You create a polyline by clicking the mouse each time you want to start
 * a new line. Double-click when you are done.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createPolyline() {
    return notesc.CreatePolyline();
}
/**
 * Lets you create a rectangle in a navigator. After you invoke the command, the
 * cursor changes to a crosshair when you start to drag the mouse in the design
 * area. You create a rectangle by dragging the mouse until the rectangle is the
 * size you want.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createRectangle() {
    return notesc.CreateRectangle();
}
/**
 * Lets you create a rectangular hotspot in a navigator. After you invoke the
 * command, the cursor changes to a crosshair when you start to drag the mouse in
 * the design area. You create a rectangular hotspot by dragging the mouse until
 * the rectangle is the size you want.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createRectangularHotspot() {
    return notesc.CreateRectangularHotspot();
}
/**
 * Creates a section.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createSection() {
    return notesc.CreateSection();
}
/**
 * Creates a new, blank subform in a database.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createSubform() {
    return notesc.CreateSubform();
}
/**
 * Lets you create a textbox in a navigator. After you invoke the command, the
 * cursor changes to a crosshair when you start to drag the mouse in the design
 * area. You create a textbox by dragging the mouse until the textbox is the size
 * you want.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createTextbox() {
    return notesc.CreateTextbox();
}
/**
 * Displays the Create View dialog box, which lets you choose a location for a new
 * view and create it.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function createView() {
    return notesc.CreateView();
}
//# sourceMappingURL=create.js.map