Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
4	17	67

Properties
%condition	%import	%includeFiles	%page
%resource	StdTitle	aboutPage	align
aux	backgroundTimerInterval	canWrite	cellAlign
cellSize	cellStyle	cellVAlign	children
composite	containerStyle	cssLevel	currPage
currSortMode	currStep	currViewMode	dataConnector
disabled	docbookId	dragAndDrop	dragEnabled
dropEnabled	enclosingClass	enclosingStyle	error
gridMode	gridSelected	groupClass	groupStyle
height	hidden	hint	hintClass
hintStyle	homePage	id	index
isModified	label	labelClass	labelDisabledClass
labelPosition	labelStyle	layout	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	pageModified	pageSize	parent
readOnly	searchKey	selectedColumn	selectedRow
showLabel	slice	title	tuple
useSVG	useSoftModals	valign	visible
width	window	worksheetDescription	worksheetKeywords
worksheetLocked	worksheetName	worksheetOwner	worksheetPublic
worksheetResource	zenPersistentPopup

Methods
%%OIDGet	%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	%Extends
%ForceClientRender	%GetChildIndex	%GetComponent	%GetComponentById
%GetComponentByName	%GetEventHandlers	%GetLinks	%GetLocatorLinks
%GetPageName	%GetParameter	%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	ConvertParameter	CreateDataSet	Decrypt
DoLogout	DrawLocator	DrawRibbon	DrawTitle
Encrypt	EscapeHTML	EscapeURL	GetCSPURL
GetContextLinks	GetDocPage	GetLookupArray	GetNewURL
GetQuickLinks	GetWSData	HyperEventBody	HyperEventCall
HyperEventFrame	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsPrivate	Link	LookupReferences
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RewriteURL
SaveToServer	SetRecord	ShowError	StartTimer
StopTimer	ThrowError	UnescapeHTML	UnescapeURL
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore	addColumn
addRow	adjustSizes	applyChange	canUserModify
cancelPopup	changeCell	changeColumn	changeGrid
changePassword	changeRow	childrenMutated	clearStyles
correctIELayering	createComponent	createComponentNS	deleteComponent
deleteItem	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	editCellHandler
editFormatString	endModal	exposeComponent	findElement
fireOnLoadEvent	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	getCellValue	getChildIndex	getComponent
getComponentById	getCurrPageCount	getCurrPageSize	getEnclosingDiv
getHidden	getHintElement	getLabelElement	getLogicalValue
getOpener	getProperty	getSettings	getTitleAreaHeight
getType	goHome	goMenu	gotoGridPage
gotoNamespace	gotoPage	gridChange	gridEditKeyDown
gridEditKeyUp	gridKeyDown	gridRender	initEngine
invokeSuper	isOfType	launchPopupWindow	loadDataConnector
loadWorksheet	logout	makeId	moveColumnLeft
moveColumnRight	moveRowDown	moveRowUp	navigate
newWorksheet	nextGridPage	numberToColumn	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onPopupAction
onRefreshContents	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondisabledHandler	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onunloadHandler	onupdateHandler
popupActionHandler	prevGridPage	printWorksheet	recalc
refreshContents	removeChild	removeColumn	removeRow
render	renderContents	renderNavBar	renderSVG
resolveFormulaRefs	saveWorksheet	searchBlur	searchBoxHandler
searchFocus	searchKeyDown	searchKeyPress	selectCellHandler
selectColumn	selectGrid	selectRow	setActionTarget
setComponentId	setHidden	setModified	setOverlayMode
setProperty	setPropertyAll	setRecordValue	setSortMode
setSortModeHandler	setTraceOption	setViewMode	setViewModeHandler
showAbout	showHelp	startModal	startProgressBar
stopProgressBar	switchNamespace	textEditorKeyup	textOKClicked
toggleSettings	updatePropertyPanel	updateStyleControls

• parameter DOCBOOKID = "D2IMP_ch_worksheet";

Docbook ID for this page.

• parameter JSINCLUDES = "dsparser.js";

Pick up formula code.

• parameter PAGENAME = "DeepSee Worksheet Builder";

Name of this page.

• parameter RESOURCE = "%DeepSee_Admin";

This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

• property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

If true, user can modify (non-read-only) worksheet.

• property currPage as %ZEN.Datatype.integer [ InitialExpression = 0 ];

For paging grids, this is the current page number (0 based).

• property dataConnector as %ZEN.Datatype.string;

Data connector class for "dataSource" mode (including .cls extension).

• property gridMode as %ZEN.Datatype.string [ InitialExpression = "dataSet" ];

Specifies how the grid gets its data: "dataSet" or "dataSource".

• property gridSelected as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Indicates that the user has selected the entire grid.

• property pageSize as %ZEN.Datatype.integer [ InitialExpression = 10 ];

For paging grids, this is the current page size.

• property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, user cannot modify the current worksheet.

• property selectedColumn as %ZEN.Datatype.integer [ InitialExpression = 0 ];

Selected column or 0.

• property selectedRow as %ZEN.Datatype.integer [ InitialExpression = 0 ];

Selected row or 0.

• property worksheetDescription as %ZEN.Datatype.string;

Description of the saved worksheet (if any).

• property worksheetKeywords as %ZEN.Datatype.string;

Keywords of the saved worksheet (if any).

• property worksheetLocked as %ZEN.Datatype.boolean;

Locked state of the saved worksheet.

• property worksheetName as %String(ZENURL="WORKSHEET");

Name of worksheet being viewed.

• property worksheetOwner as %ZEN.Datatype.string;

Owner of the saved worksheet (if any).

• property worksheetPublic as %ZEN.Datatype.boolean;

Public state of the saved worksheet.

• property worksheetResource as %ZEN.Datatype.string;

Resource of the saved worksheet (if any).

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

Decorate the page.

• 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.

• method CreateDataSet(pGrid As %ZEN.Component.dynaGrid, pDataSet As %ZEN.Auxiliary.dataSet) as %Status

Server-side callback to provide data for the dynaGrid.

• method GetLookupArray(ByRef pParameters, Output pMetaData, Output pData) as %Status

Return JSON array of lookup information. This is used to drive a combo box.

• method GetWSData(ByRef pParameters) as %Status

Write out JSON array data for worksheets using external data source.

• classmethod LookupReferences(pRefs As %ListOfDataTypes) as %ListOfDataTypes [ ZenMethod ]

Lookup a set of formula references on the server.

• method OnDrawRibbon() as %Status

Add content to ribbon bar.

• 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 SaveToServer() as %String [ ZenMethod ]

Save data to server.

• classmethod SetRecord(pConnector As %String, pID As %String, pProp As %String, pValue As %String) as %String [ ZenMethod ]

Update a record within the data connector. Returns a message string.

• 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 applyChange(deltaId, attr) [ Language = javascript ]

Change in style control: apply to grid.

• method canUserModify() [ Language = javascript ]

Test if the user has write privilege.

• method changeCell(which) [ Language = javascript ]

Change to cell control.

• method changeColumn(which) [ Language = javascript ]

Change to column control.

• method changeGrid(which) [ Language = javascript ]

Change to control showing details of grid.

• method changeRow(which) [ Language = javascript ]

Change to row control.

• method clearStyles() [ Language = javascript ]

Clear styles for current item.

• method deleteItem() [ Language = javascript ]

Delete the selected item.

• method editCellHandler(value, which) [ Language = javascript ]

Edit cell handler for grid.

• method editFormatString(id) [ Language = javascript ]

Launch format dialog.

• method getCellValue(row, col, data) [ Language = javascript ]

Get grid cell value from engine (1-based).

• method getCurrPageCount() [ Language = javascript ]

Compute number of grid pages (dataSource mode).

• method getCurrPageSize() [ Language = javascript ]

Compute number of rows in the current page (dataSource mode).

• method getLogicalValue(row, col) [ Language = javascript ]

Get the logical value for a cell in the grid (1-based). This will return the display value if there is no logical value defined.

• method gotoGridPage(page) [ Language = javascript ]

Go to a page in the grid.

• method gridChange(which) [ Language = javascript ]

Change to grid component.

• method gridEditKeyDown() [ Language = javascript ]

Override keyhandling in cell editor.

• method gridEditKeyUp() [ Language = javascript ]

• method gridKeyDown() [ Language = javascript ]

Override keyhandling in grid.

• method gridRender() [ Language = javascript ]

Update grid.

• method initEngine() [ Language = javascript ]

Initialize the calculation engine.

• method loadDataConnector() [ Language = javascript ]

Launch the data connector finder dialog.

• method loadWorksheet() [ Language = javascript ]

Launch the worksheet finder dialog.

• method moveColumnLeft() [ Language = javascript ]

Move a column left one slot.

• method moveColumnRight() [ Language = javascript ]

Move a column right one slot.

• method moveRowDown() [ Language = javascript ]

Move a row down one slot.

• method moveRowUp() [ Language = javascript ]

Move a row up one slot.

• method newWorksheet() [ Language = javascript ]

Create a new worksheet.

• method nextGridPage() [ Language = javascript ]

Show next page in grid.

• method numberToColumn(value) [ Language = javascript ]

Convert a column number to a letter (A,B,AA).

• method onPopupAction(popupName, action, value) [ Language = javascript ]

This client event is fired when a popup page launched from this page fires an action.

• method onlayoutHandler(load) [ Language = javascript ]

Adjust sizes of components on the page.

• method prevGridPage() [ Language = javascript ]

Show previous page in grid.

• method printWorksheet() [ Language = javascript ]

Show a PDF preview of this worksheet.

• method recalc() [ Language = javascript ]

Recalculate worksheet (updating references).

• method removeColumn() [ Language = javascript ]

Remove a column from the grid.

• method removeRow() [ Language = javascript ]

Remove a row from the grid.

• method renderNavBar() [ Language = javascript ]

Draw contents of nav bar.

• method resolveFormulaRefs(engine) [ Language = javascript ]

Resolve references to external worksheets.

• method saveWorksheet(showDialog) [ Language = javascript ]

Launch the save worksheet dialog.

• method selectCellHandler(row, col) [ Language = javascript ]

Select handler for grid.

• method selectColumn(col) [ Language = javascript ]

User click on column.

• method selectGrid() [ Language = javascript ]

User click on grid (upper left).

• method selectRow(row) [ Language = javascript ]

User click on rows.

• method setActionTarget(target) [ Language = javascript ]

User click on radio button to change target.

• method setRecordValue(id, prop, value) [ Language = javascript ]

Update a cell within a dataSource grid.

• method textEditorKeyup() [ Language = javascript ]

• method textOKClicked() [ Language = javascript ]

• method toggleSettings() [ Language = javascript ]

Toggle display of settings (property tabs) box.

• method updatePropertyPanel() [ Language = javascript ]

Update contents of property panel.

• method updateStyleControls() [ Language = javascript ]

Make style controls match current selection.