Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [NLS]
Private  Storage   

class %CSP.UI.Portal.NLS extends %CSP.UI.Portal.Template

Zen page for System Management Portal - NLS Locale Definition

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 37


Summary

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

Properties
%condition %import %includeFiles %page
%resource FirstFailed HelpAddress ISREADONLY
InvalidParam IsEMSReadOnly IsEditForm LocatorHeader
OnclickArray PID ParentURL StdTitle
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 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 %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 CopyNow Decrypt DeleteNow
DoLogout DrawLocator DrawResult DrawRibbon
DrawTableNames DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult ExecuteRS ExportNow
GetCSPURL GetContextLinks GetDocURL GetHomePage
GetLocaleDesc GetLocaleDescription GetNewURL GetQuickLinks
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields InstallNow IsPrivate JavaInstalled
Link LoadTableNow OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RegisterRecent ReloadDefault RewriteURL
SaveNow ShowError StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL ValidateInstall
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore afterSave
afterValidate browseSelect cancelPopup changePassword
changedDefault changedLocale childrenMutated copyLocale
correctIELayering createComponent createComponentNS deleteComponent
deleteLocale disableCommandButton displayResult doCancel
doCopy doExport doInstall doLoadTable
doModified dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler edit
enableCommandButton endModal exportLocale exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getEnclosingDiv getHidden getHintElement getLabelElement
getLocale getOpener getPageTitle getProperty
getSettings getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
hideFlds installLocale invokeSuper isButtonDisabled
isOfType launchPopupWindow loadTable 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 tablenameChanged
tabletypeChanged trimSpace validateLocale 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.NLS.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,Locale Definitions";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "Locale Definitions";
Displayed name of this page.
• parameter RESOURCE = "%Admin_Manage";
Security requirement

Methods

• method %OnAfterCreatePage() as %Status
Set Locator bar and determine whether to show change password option.
• method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
• classmethod CopyNow(sLoc As %String, sNew As %String, Description As %String) as %String [ ZenMethod ]
Copy selected locale
• classmethod DeleteNow(locale As %String) as %String [ ZenMethod ]
Delete selected locale.
• method DrawResult(seed As %String) as %Status
Actually write out result. When the page is first opened, seed is null. When it's called from Prepare, seed = action^the selected locale.
• classmethod DrawTableNames(locale, table As %String) as %String [ ZenMethod ]
Load Table Names drop-down list based on user selected table type. Build temp array Properties which contains the table names for this table type.
• method ExecuteRS(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
This method is called when the query is run for the locale list.
• classmethod ExportNow(locale, FileName) as %String [ ZenMethod ]
Export selected locale.
• classmethod GetLocaleDesc(locale As %String) as %ZEN.proxyObject [ ZenMethod ]
Return an updated title description
• classmethod GetLocaleDescription(locale As %String) as %String
• classmethod InstallNow(locale) as %String [ ZenMethod ]
Install selected locale. Validation is already done before coming here.
• classmethod LoadTableNow(locale, tabletype, tablename) as %String [ ZenMethod ]
Load locale table.
• classmethod ReloadDefault(locale As %String, defaultFormat As %Integer) as %String [ ZenMethod ]
Save "Use locale date/time/number formats for current locale" and then reload.
• classmethod SaveNow(locale As %String) as %String [ ZenMethod ]
Save selected locale.
• classmethod ValidateInstall(locale As %String) as %String [ ZenMethod ]
Validate if the locale is installable Return 1 if ok; 0 if there are errors; 2 if there are warnings Error message or warnings will be set to message fields.
• method browseSelect(name, wildcard) [ Language = javascript ]
User clicked one of the Browse buttons. Save the name of the textfield so that when you return you know which textfield to update.
• method changedDefault(newVal) [ Language = javascript ]
User changed default. Call server method to reload.
• method changedLocale(locale) [ Language = javascript ]
User changed a locale. If it's null, then disable buttons
• method copyLocale() [ Language = javascript ]
User clicked "Copy" button. Show Copy fields.
• method deleteLocale() [ Language = javascript ]
User clicked "Delete" button.
• method displayResult(ok) [ Language = javascript ]
After running action, display error message or refresh page.
• method doCancel() [ Language = javascript ]
User clicked Cancel. Hide sub form.
• method doCopy() [ Language = javascript ]
User clicked OK for Copy. Set seed, show and redraw the content.
• method doExport() [ Language = javascript ]
User clicked OK for Export. Process Export.
• method doInstall() [ Language = javascript ]
User clicked Install Now for Installing a new locale. Process Install.
• method doLoadTable() [ Language = javascript ]
User clicked OK for Load Table. Process Load Table.
• method edit() [ Language = javascript ]
• method exportLocale() [ Language = javascript ]
User clicked "Export" button. Show Export fields.
• method getLocale() as %String [ Language = javascript ]
• method hideFlds() [ Language = javascript ]
hide all fields
• method installLocale() [ Language = javascript ]
User clicked "Install" button. Show Install fields.
• method loadTable() [ Language = javascript ]
User clicked "Load Table" button. Show Load Table fields.
• method 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.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method tablenameChanged(tablename) [ Language = javascript ]
User changed a character set table name.
• method tabletypeChanged(table) [ Language = javascript ]
User changed a table type. Load table names based on the table type selected.
• method validateLocale() [ Language = javascript ]
User clicked Validate. Set seed, show and redraw the content.

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.