Skip to main content


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.

Property Inventory

Method Inventory


parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.
parameter DOMAIN = Ensemble;
Inherited description: Localization domain
parameter RESOURCE = %Ens_Portal:USE;
Inherited description: 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:
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.


property canViewFileSystem as %Boolean [ InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];
Is the user permitted to access the fileSelect popup.
Property methods: canViewFileSystemDisplayToLogical(), canViewFileSystemGet(), canViewFileSystemIsValid(), canViewFileSystemLogicalToDisplay(), canViewFileSystemLogicalToXSD(), canViewFileSystemNormalize(), canViewFileSystemSet(), canViewFileSystemXSDToLogical()
property exportInfoText as %ZEN.Datatype.string (ZENURL = "EXPINFO") [ InitialExpression = $$$TextHTML("Select the location and name for the export file") ];
Property methods: exportInfoTextDisplayToLogical(), exportInfoTextGet(), exportInfoTextIsValid(), exportInfoTextLogicalToDisplay(), exportInfoTextLogicalToOdbc(), exportInfoTextNormalize(), exportInfoTextSet()
property localDefault as %ZEN.Datatype.string (ZENURL = "LCLDEFAULT") [ InitialExpression = "export.txt" ];
Property methods: localDefaultDisplayToLogical(), localDefaultGet(), localDefaultIsValid(), localDefaultLogicalToDisplay(), localDefaultLogicalToOdbc(), localDefaultNormalize(), localDefaultSet()
property serverDir as %ZEN.Datatype.string (ZENURL = "SRVDIR") [ InitialExpression = $$$FileNormalizeDirectory(##class(%Stream.FileBinary).DefaultStreamDir(1)) ];
Property methods: serverDirDisplayToLogical(), serverDirGet(), serverDirIsValid(), serverDirLogicalToDisplay(), serverDirLogicalToOdbc(), serverDirNormalize(), serverDirSet()
property serverWildCard as %ZEN.Datatype.string (ZENURL = "SRVWILD") [ InitialExpression = "*.txt" ];
Property methods: serverWildCardDisplayToLogical(), serverWildCardGet(), serverWildCardIsValid(), serverWildCardLogicalToDisplay(), serverWildCardLogicalToOdbc(), serverWildCardNormalize(), serverWildCardSet()
property showCharSet as %ZEN.Datatype.boolean (ZENURL = "SHOWCHARSET") [ InitialExpression = 1 ];
Property methods: showCharSetDisplayToLogical(), showCharSetGet(), showCharSetIsValid(), showCharSetLogicalToDisplay(), showCharSetLogicalToOdbc(), showCharSetLogicalToXSD(), showCharSetNormalize(), showCharSetSet(), showCharSetXSDToLogical()


method %OnAfterCreatePage() as %Status
Inherited description: Avoid writing out the session cookie if we are in a Studio session.
method %OnGetSubtitle() as %String
Inherited description: Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Inherited description: 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.
clientmethod browseSelect(name, wildcard) [ Language = javascript ]
User clicked the Browse button.
clientmethod doLocationChange(radioSet) [ Language = javascript ]
User changed to export file between Server or Browser
clientmethod getDialogValue() [ Language = javascript ]
Inherited description: Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.
clientmethod 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".
clientmethod 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.
clientmethod 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.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab