Home > Class Reference > %SYS namespace > %DeepSee.UI.WorksheetBuilder


class %DeepSee.UI.WorksheetBuilder extends %DeepSee.UI.standardPage

This lets a user create and edit worksheets. A worksheet can be used as a source of KPI values or to drive dashboards.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 5 47


This is a Zen Page class. It belongs to the application %ZEN.Portal.Application.

%condition %import %includeFiles %model
%page %resource StdTitle aboutPage
align aux backgroundTimerInterval canWrite
cellAlign cellSize cellStyle cellVAlign
children composite contactPage containerStyle
cssLevel currSortMode currStep currViewMode
disabled docbookId dragAndDrop dragEnabled
dropEnabled enableAutoRefresh enclosingClass enclosingStyle
error groupClass groupStyle height
hidden hint hintClass hintStyle
homePage id index label
labelClass labelDisabledClass labelPosition labelStyle
layout limitPopups name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent readOnly searchKey
showLabel slice title tuple
useSVG useSoftModals valign visible
whichCell width window worksheetName
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToSaveSet %ApplyURLParms %Attr
%BindExport %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSStrings %DrawObjectDefinitions %EnclosingDivId %EndBackgroundMethod
%EndScript %Eval %EvalC %Extends
%ForceClientRender %GetChildIndex %GetComponent %GetComponentById
%GetComponentByName %GetEventHandlers %GetLinks %GetLocatorLinks
%GetPageName %GetParameter %GetRootLink %GetValueById
%GetValueByName %GetXMLName %IsA %IsModified
%Link %LinkCSS %LinkScript %MakeId
%New %NormalizeObject %ObjectModified %OnAddToPageAfter
%OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication
%OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody
%OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask
%OnGetPageName %OnGetProductName %OnGetSmallMenu %OnGetTitle
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %Register
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%ZENVersion BuildMenu CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt Delete DoLogout
DrawHelp DrawLocator DrawRibbon DrawTitle
Encrypt EscapeHTML EscapeURL GetCSPURL
GetContextLinks GetDocURL GetNewURL GetQuickLinks
GetWorksheetContent HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate Link
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RewriteURL
ShowError StartTimer StopTimer SubmitWorksheet
ThrowError UnescapeHTML UnescapeURL XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addColumn addRow
adjustSizes applyModelToGrid browseSubjectAreas canUserModify
cancelPopup cellControlChange changePassword changeWorksheet
childrenMutated correctIELayering createComponent createComponentNS
dataChange deleteComponent deleteWorksheet disableCommandButton
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler enableCommandButton endModal
exportWorksheet exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getCellOverride
getChildIndex getColumnDescriptors getComponent getComponentById
getContentForLevel getData getDataByName getDimSize
getEnclosingDiv getGrid getHidden getHintElement
getLabel getLabelElement getModel getNavigator
getOpener getPageTitle getProperty getPropertyName
getRowDescriptors getSettings getTitleAreaHeight getType
goHome goMenu gotoNamespace gotoPage
gridKeyDown headerClick hideCommandButton invokeSuper
isOfType launchColorChooser launchPopupWindow logout
makeId navigate newWorksheet notifyController
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshContents reloadPage
removeChild removeColumn removeRow render
renderContents renderSVG saveWorksheet searchBlur
searchBoxHandler searchFocus searchKeyDown searchKeyPress
selectCell selectItem setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode setPageTitle
setProperty setPropertyAll setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showContact showHelp startModal
startProgressBar stopProgressBar switchNamespace


If this page has multiple views, this is its initial display mode.
parameter DOCBOOKID = "D2MODADV_ch_worksheet";
Docbook ID for this page.
parameter JSINCLUDES = "dsparser.js";
Pick up formula code.
parameter PAGENAME = "Worksheet Manager";
Displayed name of this page.


property %model as %DeepSee.UserLibrary.Worksheet;
Local copy of worksheet object.
property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify (non-read-only) worksheet.
property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, user cannot modify the current worksheet.
property whichCell as %String;
Indicates what the cell value editor is showing: "cell","row", or "column".
property worksheetName as %String(ZENURL="WORKSHEET");
Name of worksheet being viewed.


method %OnAfterCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetProductName() as %String
Get the product name for the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
classmethod %OnPreHTTP() as %Boolean
Test for additional resources.
classmethod %OnSubmit(pSubmit As %ZEN.Submit) as %Status
This callback is called when the upload form on this page is submitted. pSubmit is a %ZEN.Submit object containing details of the form submit.
method Delete(pName As %String) as %String [ ZenMethod ]
Delete a worksheet.
method DrawHelp(pSeed As %String) as %Status
Draw the help panel.
method GetWorksheetContent(ByRef pParameters, Output pObject As %RegisteredObject) as %Status
Get content object for JSON provider.
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
method SubmitWorksheet(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %RegisteredObject, ByRef pResponseObject As %RegisteredObject) as %Status
Object submit handler JSON provider. This is called when the client saves the worksheet.
method addColumn() [ Language = javascript ]
Add a column to the grid
method addRow() [ Language = javascript ]
Add a row to the grid
method adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
method applyModelToGrid() [ Language = javascript ]
Apply saved attributes to the grid component. There is a copy of this method in the worksheet widget.
method browseSubjectAreas() [ Language = javascript ]
Launch the subject area finder.
method canUserModify() [ Language = javascript ]
Test if the user has write privilege.
method cellControlChange() [ Language = javascript ]
Change to value in cell value control.
method changeWorksheet() [ Language = javascript ]
Launch the worksheet finder dialog.
method dataChange(key, value, final) [ Language = javascript ]
Data change in navigator
method deleteWorksheet() [ Language = javascript ]
Delete the worksheet.
method exportWorksheet() [ Language = javascript ]
Export the worksheet.
method getCellOverride(row, col) [ Language = javascript ]
Get cell override.
method getColumnDescriptors() [ Language = javascript ]
Return an array of column descriptors (or null).
method getContentForLevel(level, key, value) [ Language = javascript ]
Return an object describing what to display for this level within the navigator.
method getData(d1, d2, d3) [ Language = javascript ]
dataSet API Return the data contained in the specified location. Location is 0-based;
method getDataByName(prop, series) [ Language = javascript ]
dataBag API Get a data value, by property name, from this dataController.
method getDimSize(dim) [ Language = javascript ]
Controller API
method getGrid() [ Language = javascript ]
Get the grid component.
method getLabel(n, dim) [ Language = javascript ]
dataSet API Get the label at position n (0-based) in the given dimension (1,2, or 3).
method getModel() [ Language = javascript ]
Get the json-supplied data model.
method getNavigator() [ Language = javascript ]
Get the navigator component.
method getPropertyName(n) [ Language = javascript ]
Given a 0-based index, return the corresponding property name.
method getRowDescriptors() [ Language = javascript ]
Return an array of row descriptors (or null).
method gridKeyDown(evt) [ Language = javascript ]
Key down handler for grid.
method headerClick(which, index) [ Language = javascript ]
Click on header in grid.
method launchColorChooser() [ Language = javascript ]
Launch the color chooser.
method newWorksheet() [ Language = javascript ]
Create a new worksheet.
method notifyController(source, reason, prop, value, row) [ Language = javascript ]
Notification from the dataGrid.
method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
method removeColumn() [ Language = javascript ]
Remove a column from the grid.
method removeRow() [ Language = javascript ]
Remove a row from the grid.
method saveWorksheet(showDialog) [ Language = javascript ]
Launch the save worksheet dialog.
method searchBoxHandler(searchKey) [ Language = javascript ]
Change in search box value. Can be overridden by subclasses.
method selectCell(row, col) [ Language = javascript ]
Select cell handler.
method selectItem(key, value) [ Language = javascript ]
Item selected in navigator.