Class %DeepSee.UserLibrary.Worksheet

persistent class %DeepSee.UserLibrary.Worksheet extends %DeepSee.UserLibrary.FolderItem

This class represents a DeepSee Worksheet within a DeepSee folder.
This class also provides the APIs for working with DeepSee "worksheets". A worksheet can be used in several ways:
1) You can use a worksheet to define a specialized KPI containing user-entered data that drives other dashboard widgets.
2) You can use a worksheet to feed values into other DeepSee components, such as pivot tables.
3) You can use a worksheet to enter and display a grid of values.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
4	25	13

Summary

Properties
ReadOnly	Timestamp	bookCover	borders
category	cells	columnHeaderStyle	columnHeaders
columnWidth	createdBy	dataConnector	description
documentName	folder	folderName	format
fullName	gridMode	keywords	lastAccessed
locked	name	owner	pageSize
public	resource	rowHeaderStyle	rowHeaders
shared	showColumnLabels	showRowLabels	showZebra
style	timeCreated	timeModified	title
xmlCells	xmlValues

Methods
%%CLASSNAMELogicalToStorage	%%CLASSNAMEStorageToLogical	%AddToSaveSet	%AddToSyncSet
%BMEBuilt	%BuildIndicesAsync	%BuildIndicesAsyncResponse	%CheckConstraints
%CheckConstraintsForExtent	%CheckResource	%ClassIsLatestVersion	%ClassName
%ComposeOid	%ConstructClone	%Delete	%DeleteExtent
%DeleteId	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%Dump	%Exists	%ExistsId	%Extends
%GUID	%GUIDSet	%GetCoverSpec	%GetDependencies
%GetIcon	%GetLargeIcon	%GetLock	%GetParameter
%GetResource	%GetSwizzleObject	%GetTypeName	%GetURL
%Id	%InsertBatch	%IsA	%IsModified
%IsNull	%KillExtent	%KillExtentData	%LoadFromMemory
%LockExtent	%LockId	%Lookup	%New
%NormalizeObject	%ObjectIsNull	%ObjectModified	%Oid
%OnAfterImport	%OnBeforeAddToSync	%OnDeleteFinally	%OnDetermineClass
%OnOpenFinally	%OnSaveFinally	%Open	%OpenId
%OriginalNamespace	%PackageName	%ParseFullName	%PhysicalAddress
%PurgeIndices	%Reload	%RemoveFromSaveSet	%ResolveConcurrencyConflict
%RollBack	%Save	%SaveDirect	%SaveIndices
%SerializeObject	%SetModified	%SortBegin	%SortEnd
%SyncObjectIn	%SyncTransport	%UnlockExtent	%UnlockId
%ValidateIndices	%ValidateObject	%ValidateTable	XMLBeforeExport
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
documentNameGet	folderNameGet	folderNameSet	fullNameFromDocumentName
fullNameGet	fullNameSet

Parameters

• parameter ICON = "deepsee/ds2_list_44.png";

URL of icon for this item

• parameter ITEMTYPE = "worksheet";

This is the extension returned by this type from the Finder.

• parameter LARGEICON = "deepsee/ds2_list_44.png";

URL of large icon for this item

• parameter XMLNAME = "worksheet";

This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

• property borders as %ZEN.Datatype.string(XMLPROJECTION="attribute");

Specify whether cell borders should be "all" (the default) or "none".

• property cells as list of WorksheetCell(XMLNAME="cellDef",XMLPROJECTION="ELEMENT");

This contains the definition of (overridden) cells for this worksheet.

• property columnHeaderStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");

Additional style to apply to column headers in this grid.

• property columnHeaders as list of WorksheetAxis(XMLNAME="columnHeader",XMLPROJECTION="ELEMENT");

This contains the definition of the column headers for this worksheet.

• property columnWidth as %ZEN.Datatype.integer;

Default column width.

• property dataConnector as %ZEN.Datatype.string(XMLPROJECTION="attribute");

Name of data connector class used by the grid (in "dataSource" mode).

• property format as %ZEN.Datatype.string(XMLPROJECTION="attribute");

Default format to apply to cells in this worksheet.

• property gridMode as %ZEN.Datatype.string(XMLPROJECTION="attribute");

Data mode for the worksheet: "dataSet" or "dataSource".

• property pageSize as %ZEN.Datatype.integer(XMLPROJECTION="attribute");

Page size used by the grid (in "dataSource" mode).

• property rowHeaderStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");

Additional style to apply to row headers in this grid.

• property rowHeaders as list of WorksheetAxis(XMLNAME="rowHeader",XMLPROJECTION="ELEMENT");

This contains the definition of the row headers for this worksheet.

• property showColumnLabels as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 1 ];

Specifies whether column labels should be displayed.

• property showRowLabels as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 1 ];

Specifies whether row labels should be displayed.

• property showZebra as %ZEN.Datatype.boolean(XMLPROJECTION="attribute");

Specify whether zebra striping should be applied to the grid.

• property style as %ZEN.Datatype.style(XMLPROJECTION="attribute");

Additional style to apply to cells in this worksheet.

• property xmlCells as list of %String(XMLNAME="cell",XMLPROJECTION="ELEMENT") [ Transient ];

This is used to hold cell values when they are exported to XML.

• property xmlValues as list of %String(XMLNAME="value",XMLPROJECTION="ELEMENT") [ Transient ];

This is used to hold cell (resolved) values when they are exported to XML.

Methods

• method %GetTypeName() as %String

Return the localized type name for this item.

• method %GetURL() as %String

Return the URL for this item.

• method %Lookup(pIdent As %String) as %String

Formula function: Lookup the value of the given identifier.

• method %OnAfterImport() as %Status

Notification that this item has just been imported.

• method XMLBeforeExport()

Notification before xml export.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search