This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%CSP.UI.Portal.Dialog.Export

class %CSP.UI.Portal.Dialog.Export extends %CSP.UI.Portal.Dialog.WizardTemplate

This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Export dialog for Management Portal.

Please do not modify any part of this dialog without COMPLETELY testing all cases!!!
This dialog is used by Classes/Routines/Globals for both Namespaces and Databases.
Please be extremely careful!!!

Property Inventory

Method Inventory

Parameters

parameter APPLICATION = %CSP.UI.Portal.Application;
Class name of application this page belongs to.
parameter APPLYBUTTON = 0;
If true, then this dialog displays an Apply button.
parameter AUTONS = 1;
Inherited description: If $NAMESPACE is set, auto switch namespace
parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.Dialog.Export.zen;
Inherited description: 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 PAGENAME = Export;
Displayed name of this page.
parameter RESOURCE = %Development: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:
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 EXPORTALL as %ZEN.Datatype.string (ZENURL = "EXPORTALL");
Property methods: EXPORTALLDisplayToLogical(), EXPORTALLGet(), EXPORTALLIsValid(), EXPORTALLLogicalToDisplay(), EXPORTALLLogicalToOdbc(), EXPORTALLNormalize(), EXPORTALLSet()
property EXPORTFORMAT as %ZEN.Datatype.string [ InitialExpression = "XML" ];
Property methods: EXPORTFORMATDisplayToLogical(), EXPORTFORMATGet(), EXPORTFORMATIsValid(), EXPORTFORMATLogicalToDisplay(), EXPORTFORMATLogicalToOdbc(), EXPORTFORMATNormalize(), EXPORTFORMATSet()
property FILEFLAG as %ZEN.Datatype.string;
Property methods: FILEFLAGDisplayToLogical(), FILEFLAGGet(), FILEFLAGIsValid(), FILEFLAGLogicalToDisplay(), FILEFLAGLogicalToOdbc(), FILEFLAGNormalize(), FILEFLAGSet()
property FILETYPE as %ZEN.Datatype.string (ZENURL = "FILETYPE");
Type from where we get the selected items from: Class or Routine.
Property methods: FILETYPEDisplayToLogical(), FILETYPEGet(), FILETYPEIsValid(), FILETYPELogicalToDisplay(), FILETYPELogicalToOdbc(), FILETYPENormalize(), FILETYPESet()
property NAMESPACE as %ZEN.Datatype.string (ZENURL = "$NAMESPACE");
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()

Methods

method %OnAfterCreatePage() as %Status
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 %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 CheckFileStatus(pFilename) [ ZenMethod ]
classmethod DownloadStream(pFilename As %String, pDocName As %String, pCharSet As %String) [ ZenMethod ]
classmethod DrawPageTitle(pSeed As %String) as %Status
classmethod FileExists(filename) as %Integer [ ZenMethod ]
Check to see if file exists
method GetTempFileName(pDocName) as %String [ ZenMethod ]
classmethod SaveLastFile(pFileName, pFileType) [ ZenMethod ]
clientmethod browseSelect(name, wildcard) [ Language = javascript ]
User clicked the Browse button.
clientmethod checkExpObj() [ Language = javascript ]
make sure that if export OBJ is checked then the file name contains .xml
clientmethod doDownload(filename) [ Language = javascript ]
clientmethod doExport() [ Language = javascript ]
User clicked the Export or Export in Background button.
clientmethod doLocationChange(flag) [ Language = javascript ]
User changed to export file between Server or Browser
clientmethod exportOBJ(thisObj) [ Language = javascript ]
If exportOBJ checkbox is checked, then make sure the file has xml extension and background is checked and disabled.
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 onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
clientmethod onstartHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod validateFile(fileName) [ Language = javascript ]
Check if file is empty.

Inherited Members

Inherited Properties

Inherited Methods

Feedback