Class %CSP.UI.Portal.Config.ValueEditor

class %CSP.UI.Portal.Config.ValueEditor extends %CSP.UI.Portal.Template

This value editor is specific for the Configure individual Startup/Memory/Compatibility settings

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
7	6	9

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	ClassName	FirstFailed	HelpAddress
ISREADONLY	InvalidParam	IsEMSReadOnly	IsEditForm
IsRequired	LocatorHeader	OnclickArray	PID
ParentURL	StdTitle	Subject	ValidationErrorMsg
aboutPage	align	aux	backgroundTimerInterval
cellAlign	cellSize	cellStyle	cellVAlign
children	composite	contactPage	containerStyle
cssLevel	currSortMode	currStep	currViewMode
disabled	dragAndDrop	dragEnabled	dropEnabled
enableAutoRefresh	enclosingClass	enclosingStyle	error
groupClass	groupStyle	height	hidden
hint	hintClass	hintStyle	home
homePage	id	index	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	lblTitle	limitPopups	name
onafterdrag	onbeforedrag	onclick	ondrag
ondrop	onhide	onrefresh	onshow
onupdate	pType	pageModified	parent
searchKey	showLabel	slice	title
tuple	useSVG	useSoftModals	valign
visible	width	window	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%AddImportedComponents	%AddLocatorLinks	%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	%GetDescHTML	%GetEventHandlers
%GetHomePage	%GetHomeParam	%GetLinks	%GetLocatorLinks
%GetPageName	%GetParameter	%GetProductName	%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	CheckAllBlanks	CheckContextLinks
CheckEnterpriseManager	ConvertParameter	Decrypt	DoLogout
DrawAfterCreatePage	DrawLocator	DrawRibbon	DrawTitle
Encrypt	EscapeHTML	EscapeURL	EvalResult
GetCSPURL	GetContextLinks	GetDocURL	GetHomePage
GetNewURL	GetQuickLinks	HyperEventCall	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
JavaInstalled	Link	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
QuoteJS	RegisterRecent	RewriteURL	SaveData
ShowError	StartTimer	StopTimer	ThrowError
UnescapeHTML	UnescapeURL	Validate	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	addChild
addChildAfter	addChildBefore	afterSave	afterValidate
cancelPopup	changePassword	childrenMutated	correctIELayering
createComponent	createComponentNS	deleteComponent	disableCommandButton
doCancel	doModified	doSave	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	enableCommandButton	endModal	exposeComponent
findElement	fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent
firePopupAction	getChildIndex	getComponent	getComponentById
getEnclosingDiv	getHidden	getHintElement	getLabelElement
getOpener	getPageTitle	getProperty	getSettings
getTitleAreaHeight	getType	goHome	goMenu
gotoNamespace	gotoPage	hideCommandButton	invokeSuper
isButtonDisabled	isOfType	launchPopupWindow	logout
makeId	navigate	onCreate	onDelete
onDisplayHandler	onEndModalHandler	onPopupAction	onRefreshContents
onSerialize	onServerMethodCall	onServerMethodError	onServerMethodReturn
onStartModalHandler	ondisabledHandler	onhandleAutoLogoutWarn	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onunloadHandler	onupdateHandler
popupActionHandler	refreshContents	removeChild	render
renderContents	renderSVG	resetMsg	searchBlur
searchBoxHandler	searchFocus	searchKeyDown	searchKeyPress
setComponentId	setConnectivityStatusMsg	setHidden	setModified
setOverlayMode	setPageTitle	setProperty	setPropertyAll
setSortMode	setSortModeHandler	setTraceOption	setViewMode
setViewModeHandler	showAbout	showCommandButton	showContact
showDocumentation	showHelp	showMsg	startModal
startProgressBar	stopProgressBar	switchNamespace	trimSpace
validateRequired

Parameters

• parameter AUTONS = 0;

Do not switch namespace for this page: it needs to stay in %SYS

• parameter CSPURL = "/csp/sys/mgr/%CSP.UI.Portal.Config.ValueEditor.zen";

This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.

• parameter EMSSERVICE = "Config";

• parameter HELPADDRESS = "Home,Configuration";

Each SMP page should set this link which points to the documentation anchor name.

• parameter RECENT = 0;

If true, register visits to this page in the recent list.

• parameter RESOURCE = "%Admin_Manage";

Security requirement

• parameter RESTARTREQUIREDLIST = "NullSubscripts";

A CSL listing those properties that should get a restart required warning even if the parent class does not implement the NoRestartOnActivate method.

Properties

• property ClassName as %ZEN.Datatype.string(ZENURL="ClassName");

Name of the current configuration class

• property IsEditForm as %Boolean [ InitialExpression = 1 ];

If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.

• property IsRequired as %Boolean [ InitialExpression = 0 ];

• property PID as %ZEN.Datatype.string(ZENURL="PID");

ID for edit.

• property Subject as %String(ZENURL="Subject");

Subject name for the setting page.

• property pType as %ZEN.Datatype.string;

Methods

• method %GetDescHTML(pSeed As %String) as %Status

Provide contents of description component only if locale is English.

• method %GetLocatorLinks(Output pLink) as %Status

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

• method %OnAfterCreatePage() as %Status

Be sure to do ##super() when overriding.

• method %OnGetPageName() as %String

Get the (localized) name of the page. This should be implemented in a subclass.

• method DrawAfterCreatePage() as %Status

• classmethod SaveData(ConfigClass As %String, Properties As %String, Values As %String, SelectedType As %String) as %ZEN.proxyObject [ ZenMethod ]

Call server save method. Values passed in is delimited by "|" if there are more than one.

• classmethod Validate(pConfigClass As %String, ByRef pProperties As %String, ByRef pMessage As %String = "") as %Boolean

Perform any necessary validation on the values being set pMessage is the error message to be displayed if validation fails

• method doSave() [ Language = javascript ]

Check if field is required and make value is not null

• method getPageTitle() as %String [ Language = javascript ]

Get the title string to add to the locator row.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search