InterSystems IRIS Data Platform 2020.4 > Class Reference > %SYS namespace > %ZEN.Template.ZENElementInspector

%ZEN.Template.ZENElementInspector

class %ZEN.Template.ZENElementInspector extends %ZEN.Template.studioTemplate

Studio Template:
Insert a new ZEN Element within an XData definition.

Property Inventory

Method Inventory

Parameters

parameter DOMAIN = %ZEN;
Domain used for localization.
parameter HELPID = GZEN_element_wizard;
Inherited description: DOCBOOK Topic Id that offers help for this template.
parameter TEMPLATEDESCRIPTION = Inserts a Zen XML element within a Contents document.;
Inherited description: Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATEMODE = template;
What type of template.
parameter TEMPLATENAME = Zen Element Wizard;
Inherited description: Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATETITLE = Zen Element Wizard;
Inherited description: Title of the template to show in the template window.
parameter TEMPLATETYPE = cls;
Inherited description: Comma separated list of 'CSP', 'CSR', 'MAC', 'INT', 'INC', 'BAS', 'CLS' to say what type of code this template generates; CSP, CSR, Routine, or Class code. You can also specify '*' for all types.

Properties

property attrs as array of %ZEN.Datatype.string;
Array of attributes and values from the target element.
Property methods: attrsBuildValueArray(), attrsCollectionToDisplay(), attrsCollectionToOdbc(), attrsDisplayToCollection(), attrsDisplayToLogical(), attrsGet(), attrsGetObject(), attrsGetObjectId(), attrsGetSwizzled(), attrsIsValid(), attrsLogicalToDisplay(), attrsLogicalToOdbc(), attrsNormalize(), attrsOdbcToCollection(), attrsSet(), attrsSetObject(), attrsSetObjectId()
property currElementClass as %ZEN.Datatype.string;
Class name of selected element.
Property methods: currElementClassDisplayToLogical(), currElementClassGet(), currElementClassIsValid(), currElementClassLogicalToDisplay(), currElementClassLogicalToOdbc(), currElementClassNormalize(), currElementClassSet()
property currElementName as %ZEN.Datatype.string;
Name of selected element.
Property methods: currElementNameDisplayToLogical(), currElementNameGet(), currElementNameIsValid(), currElementNameLogicalToDisplay(), currElementNameLogicalToOdbc(), currElementNameNormalize(), currElementNameSet()
property editLabel as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Edit...") ];
Localized label for edit button.
Property methods: editLabelDisplayToLogical(), editLabelGet(), editLabelIsValid(), editLabelLogicalToDisplay(), editLabelLogicalToOdbc(), editLabelNormalize(), editLabelSet()
property elName as %ZEN.Datatype.string;
Name of the target element from selectedText.
Property methods: elNameDisplayToLogical(), elNameGet(), elNameIsValid(), elNameLogicalToDisplay(), elNameLogicalToOdbc(), elNameNormalize(), elNameSet()
property postText as %ZEN.Datatype.string;
Portion of selected text *after* the target element.
Property methods: postTextDisplayToLogical(), postTextGet(), postTextIsValid(), postTextLogicalToDisplay(), postTextLogicalToOdbc(), postTextNormalize(), postTextSet()
property preText as %ZEN.Datatype.string;
Portion of selected text *before* the target element.
Property methods: preTextDisplayToLogical(), preTextGet(), preTextIsValid(), preTextLogicalToDisplay(), preTextLogicalToOdbc(), preTextNormalize(), preTextSet()

Methods

method %GetDescHTML(pSeed As %String) as %Status [ Language = objectscript ]
Provide contents of description component.
method %GetElementHelpHTML(pSeed As %String = "") as %Status [ Language = objectscript ]
Provide contents of element help component.
method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method %OnTemplateAction() as %Status [ Language = objectscript ]
This method is called when the template is complete. Any output to the principal device is returned to the Studio.
method CreateElementRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet [ Language = objectscript ]
Create the result set used by the Element dataCombo.
classmethod GetElementInfo(pClass As %String) as %String [ Language = objectscript, ZenMethod ]
Return csv-list of properties for the given element.
clientmethod canGoBack() [ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable the Back button).
clientmethod canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
clientmethod computeGridValue(grid) [ Language = javascript ]
Convert the value within the property grid to something we can submit!
clientmethod drawPropCell(grid, data) [ Language = javascript ]
called when cell is about to be drawn in dynaGrid
clientmethod elementChange(cb) [ Language = javascript ]
Notification that the element combo has changed.
clientmethod formValidationHandler() [ Language = javascript ]
Validation handler for form built-into template.
clientmethod hasMultiplePages() [ Language = javascript ]
Inherited description: Return true if this template has more than one "page". This will display Back and Next buttons. This is implemented by subclasses.
clientmethod htmlRefreshHandler() [ Language = javascript ]
htmlRefreshHandler This is called when the HTML help component is refreshed from the server.
clientmethod nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
clientmethod onstartHandler() [ Language = javascript ]
This is called when the template is first displayed; This provides a chance to set focus etc.
clientmethod previousPage() [ Language = javascript ]
Go to the previous page of the template (if there is one).
clientmethod showValueEditor(propNo) [ Language = javascript ]
Launch property editor. propNo is index of property in dataSet.
clientmethod tabChange(tabGroup) [ Language = javascript ]
Notification that a new tab was selected.

Inherited Members

Inherited Properties

Inherited Methods

Feedback