Skip to main content


class %DeepSee.UI.CaptionEditor extends %DeepSee.UI.standardPage

DeepSee Caption Editor page.

Property Inventory

Method Inventory


parameter PAGENAME = Caption Editor;
Inherited description: Name of this page.


property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify (non-read-only) pivots.
Property methods: canWriteDisplayToLogical(), canWriteGet(), canWriteIsValid(), canWriteLogicalToDisplay(), canWriteLogicalToOdbc(), canWriteLogicalToXSD(), canWriteNormalize(), canWriteSet(), canWriteXSDToLogical()
property cubeFullName as %ZEN.Datatype.string (ZENURL = "CUBE");
Parameter DOCBOOKID = "D2ANLY_ch_intro"; Name of Cube (with extension).
Property methods: cubeFullNameDisplayToLogical(), cubeFullNameGet(), cubeFullNameIsValid(), cubeFullNameLogicalToDisplay(), cubeFullNameLogicalToOdbc(), cubeFullNameNormalize(), cubeFullNameSet()
property cubeName as %ZEN.Datatype.string;
Name of cube to explore.
Property methods: cubeNameDisplayToLogical(), cubeNameGet(), cubeNameIsValid(), cubeNameLogicalToDisplay(), cubeNameLogicalToOdbc(), cubeNameNormalize(), cubeNameSet()
property currCaption as %ZEN.Datatype.string;
Current caption.
Property methods: currCaptionDisplayToLogical(), currCaptionGet(), currCaptionIsValid(), currCaptionLogicalToDisplay(), currCaptionLogicalToOdbc(), currCaptionNormalize(), currCaptionSet()
property currContext as %ZEN.Datatype.string;
Current context.
Property methods: currContextDisplayToLogical(), currContextGet(), currContextIsValid(), currContextLogicalToDisplay(), currContextLogicalToOdbc(), currContextNormalize(), currContextSet()
property currDim as %ZEN.Datatype.string;
Current dimension.
Property methods: currDimDisplayToLogical(), currDimGet(), currDimIsValid(), currDimLogicalToDisplay(), currDimLogicalToOdbc(), currDimNormalize(), currDimSet()
property currHier as %ZEN.Datatype.string;
Current hierarchy.
Property methods: currHierDisplayToLogical(), currHierGet(), currHierIsValid(), currHierLogicalToDisplay(), currHierLogicalToOdbc(), currHierNormalize(), currHierSet()
property currLevel as %ZEN.Datatype.string;
Current level.
Property methods: currLevelDisplayToLogical(), currLevelGet(), currLevelIsValid(), currLevelLogicalToDisplay(), currLevelLogicalToOdbc(), currLevelNormalize(), currLevelSet()
property currProp as %ZEN.Datatype.string;
Current property.
Property methods: currPropDisplayToLogical(), currPropGet(), currPropIsValid(), currPropLogicalToDisplay(), currPropLogicalToOdbc(), currPropNormalize(), currPropSet()
property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, user cannot modify captions.
Property methods: readOnlyDisplayToLogical(), readOnlyGet(), readOnlyIsValid(), readOnlyLogicalToDisplay(), readOnlyLogicalToOdbc(), readOnlyLogicalToXSD(), readOnlyNormalize(), readOnlySet(), readOnlyXSDToLogical()


Return the array of links to show in the locator bar.
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 name for 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.
classmethod DeleteItem(pCube As %String, pContext As %String, pDim As %String, pHier As %String, pLevel As %String, pProp As %String) as %String [ ZenMethod ]
Delete a caption.
method DrawCubeName(pSeed As %String) as %Status
Draw cube name above member tree.
classmethod GetDimensionInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status
Provide contents of the dimension tree.
method OnDrawRibbon() as %Status
Draw additional stuff in the 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.
classmethod ParseValue(pCube As %String, pContext As %String, pValue As %String) as %String [ ZenMethod ]
Pull apart the given member spec.
classmethod SaveItem(pCube As %String, pContext As %String, pDim As %String, pHier As %String, pLevel As %String, pProp As %String, pCaption As %String) as %String [ ZenMethod ]
Save a caption.
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod changeSubjectArea() [ Language = javascript ]
Launch the subject area finder dialog.
clientmethod contextChange(ctx) [ Language = javascript ]
User has selected a new context.
clientmethod deleteCaption() [ Language = javascript ]
Delete the current caption.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod saveCaption() [ Language = javascript ]
Save the current caption.
clientmethod treeChange(tree) [ Language = javascript ]
User has selected a new element in the tree control.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab