Learning
Documentation
Community
Open Exchange
Global Masters
Home > Class Reference > ENSLIB namespace > EnsPortal.Dialog.fileSelect
Private  Storage   

EnsPortal.Dialog.fileSelect


class EnsPortal.Dialog.fileSelect extends
EnsPortal.Dialog.standardDialog

Used to select a server side file name or specify a local filename for target of an export

This class is used internally by InterSystems. You should not make direct use of it within your applications.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 6 10


Summary


This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%ComponentClasses %ComponentNames %Components %CompositeList
%DeletedIds %NotifyList %RenderList %UserPackageList
%condition %import %includeFiles %page
%partial %resource %xmlOutputMode FirstFailed
InvalidParam IsEMSReadOnly SVGClassList UserSVGPackageList
ValidationErrorMsg align aux backgroundTimerInterval
canEdit canViewFileSystem cellAlign cellSize
cellStyle cellVAlign children closeOnEnter
closeOnEsc composite containerStyle cssLevel
designMode dialogTitle disabled disabledStyle
dragAndDrop dragEnabled dropEnabled dynamic
enclosingClass enclosingStyle error exportInfoText
groupClass groupStyle hasButtons height
hidden hideApplyButton hideCancelButton hideOKButton
hint hintClass hintStyle id
index inlineSVG isPopup isSoftModal
keepAliveInterval label labelClass labelDisabledClass
labelPosition labelStyle lastModalIndex layout
localDefault msgNotPermitted name nextIndex
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onoverlay onrefresh
onshow onupdate overlayMode parent
popupParent renderFlag serverDir serverWildCard
showCharSet showLabel slice studioMode
title tuple useSVG useSoftModals
valign visible width window
zenPersistentPopup

Methods
%%OIDGet %AddCSPShareHyperevents %AddChild %AddChildAfter
%AddChildBefore %AddComponent %AddEnsExceptionHandler %AddImportedComponents
%AddToSaveSet %ApplyURLParms %Attr %BindExport
%BuildObjectGraph %ClassIsLatestVersion %ClassName %Close
%ConstructClone %CreateApplication %CreatePage %DetermineCSSLevel
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinition %DrawClassDefinitions %DrawComponentHTML %DrawHTML
%DrawHTMLPage %DrawJSGetSettings %DrawJSSerialize %DrawJSStrings
%DrawObjectDefinitions %DrawObjectProperties %DrawSVGDef %DrawStyleDefinitions
%DrawStyleHTML %DrawStyleSVG %DrawTitle %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GenerateCode %GetChildIndex
%GetClassCRC %GetClassDepth %GetComponent %GetComponentById
%GetComponentByName %GetComponentPropertyById %GetDependentComponents %GetEventHandlers
%GetIncludeFiles %GetIncludeInfo %GetLinks %GetPageName
%GetPaneContents %GetParameter %GetSuperClassList %GetValueById
%GetValueByName %GetXMLName %IncrementCount %IsA
%IsEmbedded %IsModified %Link %LinkCSS
%LinkScript %MakeId %New %NormalizeObject
%ObjectModified %ObjectSynch %OnAddToPage %OnAddToPageAfter
%OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication
%OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody
%OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask
%OnGetSubtitle %OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren
%OnObjectSynch %OnPreHTTP %OnSubmit %OnUseSoftModals
%OnZENDeserialize %OriginalNamespace %PackageName %QuoteValue
%QuoteValueL10N %ReallyAddChild %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod %Self
%SerializeObject %SetBackgroundMethodStatus %SetErrorById %SetErrorByName
%SetModified %SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %XMLGenerate %ZENDeserialize
%ZENVersion ConvertParameter Decrypt DrawInfo
Encrypt EncryptBroker EscapeHTML EscapeURL
EvalResult GetHyperEventResources HyperEventBody HyperEventCall
HyperEventFrame HyperEventHead Include InsertHiddenField
InsertHiddenFields InvokeClassMethod InvokeInstanceMethod IsPrivate
Link LoadZenComponent MonitorBackgroundTask OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
ReallyRefreshContents RewriteURL ShowError SimpleKeepAlive
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL XMLAfterExport XMLBeforeExport XMLDTD
XMLExport XMLExportInternal XMLExportToStream XMLExportToString
XMLGetSchemaImports XMLImport XMLImportInternal XMLIsObjectEmpty
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addPopupSuffix
adjustSize backgroundTimerHandler browseSelect btnApply
btnOK cancelPopup checkEdit childrenMutated
clearBackgroundTask clientKeepAlive correctIELayering createComponent
createComponentNS ctrlKeyDown deleteComponent dialogApply
dialogCancel dialogFinish dialogTitleGet disableButtons
doLocationChange dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler endModal
exposeComponent findElement fireOnLoadEvent fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getDialogValue getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getTargetPage getType
gotoPage inResizeLoop initPopupSuffix invokeSuper
isOfType launchPopupWindow makeId onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondialogCancel ondialogFinish
ondialogStart ondisabledHandler onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler popupActionHandler
progressBarHandler refreshContents removeChild removePopupSuffix
render renderContents renderSVG resetMsg
setBackgroundTask setComponentId setHidden setOverlayMode
setProperty setPropertyAll setTraceOption showMsg
startKeepAlive startModal startProgressBar stopKeepAlive
stopProgressBar updateControlsInGroup validateRequired


Parameters


• parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
• parameter DOMAIN = "Ensemble";
Localization domain
• parameter RESOURCE = "%Ens_Portal:USE";
This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties


• property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
• property exportInfoText as %ZEN.Datatype.string(ZENURL="EXPINFO") [ InitialExpression = $$$TextHTML("Select the location and name for the export file") ];
• property localDefault as %ZEN.Datatype.string(ZENURL="LCLDEFAULT") [ InitialExpression = "export.txt" ];
• property serverDir as %ZEN.Datatype.string(ZENURL="SRVDIR") [ InitialExpression = $$$FileNormalizeDirectory(##class(%Stream.FileBinary).DefaultStreamDir(1)) ];
• property serverWildCard as %ZEN.Datatype.string(ZENURL="SRVWILD") [ InitialExpression = "*.txt" ];
• property showCharSet as %ZEN.Datatype.boolean(ZENURL="SHOWCHARSET") [ InitialExpression = 1 ];

Methods


• method %OnAfterCreatePage() as %Status
Avoid writing out the session cookie if we are in a Studio session.
• method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
• method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
• method DrawInfo(pSeed As %String) as %Status
Draw contents of description box.
• method browseSelect(name, wildcard) [ Language = javascript ]
User clicked the Browse button.
• method doLocationChange(radioSet) [ Language = javascript ]
User changed to export file between Server or Browser
• method getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
Returning from file select OR qualifers dialog and setting the value into the appropriate field. The id of the field that needs to be updated is saved in "dialogClicked".
• method ondialogCancel() [ Language = javascript ]
This callback, if defined, is called when the user presses the Cancel button. If this returns false, then the dialog is not cancelled.
• method ondialogFinish(action) as %Boolean [ Language = javascript ]
This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.