$forms
Updated on Aug 25, 2025 5 minutes to readThe Forms Plugin provides methods to open, display, download, and manage forms within the application. It also allows manipulation of the form window title and access to form parameters.
Methods
| Method | Description |
|---|---|
| downloadPrintForm | Downloads a print-ready version of a form. |
| getParam | Retrieves a single form parameter by name. |
| getParams | Retrieves all form parameters as an object. |
| getPrintForm | Fetches a print form and returns its data. |
| getTitle | Gets the current window or modal title. |
| open | Opens a form for viewing or editing. |
| openModal | Opens a form inside a modal window. |
| openPrintForm | Opens a print form in a modal for display. |
| setTitle | Sets or resets the form title. |
Methods Details
downloadPrintForm()
• Type
(
listScriptAlias: E8ScriptAlias,
id: E8ObjectId | E8ObjectId[],
printFormScriptAlias: E8ScriptAlias | E8ScriptAlias[],
params?: PrintFormParams
) => void• Details
Expects the script alias for the list,
the record ID(s),
the print form script alias(es),
and optional PrintFormParams (default: { inline: true }).
Triggers a download of the print-ready form.
getParam()
• Type
(name: string) => any• Details
Expects the name of the parameter.
Returns the value of the specified form parameter.
getParams()
• Type
() => object• Details
Returns an object containing all parameters of the current form.
getPrintForm()
• Type
(
listScriptAlias: E8ScriptAlias,
id: E8ObjectId | E8ObjectId[],
printFormScriptAlias: E8ScriptAlias | E8ScriptAlias[],
params?: PrintFormParams
) => Promise<PrintFormResult>• Details
Expects the script alias for the list,
the record ID(s),
the print form script alias(es),
and optional PrintFormParams (default: { inline: true }).
Returns a Promise resolving to a PrintFormResult object containing form content and recipient details.
getTitle()
• Type
() => string• Details
Returns the current title of the form window or modal.
open()
• Type
(
scriptAlias: E8ScriptAlias,
id: E8ObjectId | null,
fillingValues?: object,
formScriptAlias?: E8ScriptAlias,
sourceId?: E8ObjectId | null
) => void• Details
Expects the script alias for the form,
optional record ID,
optional initial values (Record<string, any>),
optional form script alias,
and optional source ID for copying object.
Opens the form in the standard view.
openModal()
• Type
(
scriptAlias: E8ScriptAlias,
id: E8ObjectId | null,
fillingValues?: object,
formScriptAlias?: E8ScriptAlias,
sourceId?: E8ObjectId | null,
formSize?: FormSizes
) => void• Details
Expects the script alias for the form,
an optional record ID,
optional initial values (Record<string, any>),
an optional form script alias,
an optional source ID for copying an object,
and an optional FormSize (default: the size defined in the form builder).
Opens the form in a modal window.
openPrintForm()
• Type
(
listScriptAlias: E8ScriptAlias,
id: E8ObjectId | E8ObjectId[],
printFormScriptAlias: E8ScriptAlias | E8ScriptAlias[],
params?: PrintFormParams
) => void• Details
Expects the script alias for the list,
the record ID(s),
the print form script alias(es),
and optional PrintFormParams (default: { inline: true }).
Opens the print form in a modal window for display.
setTitle()
• Type
(title: string | null) => void• Details
Expects a string to set as the form title. If null is provided, resets to the default title.