Class SY_CommonUI

Inherits

*NOMADS, SY_Constant

Known SubClasses

AP_Form1099eFileandReport_ui, AR_OpenInvoicePaymentsToday_UI, CI_ColumnSortSelection_ui, CM_UDFMaint_UI, FL_PeriodEndProcessing_ui, IM_ItemTransInquiry_ui, IM_LotSerialWhereUsed_ui, SY_CompanyConversion_ui, SY_ConfigData_ui, SY_FileDisplaySettings_ui, SY_FileDisplay_ui, SY_MaintUI, SY_ReportManager_UI, SY_Selection, VI_ExportPreSelect_UI, VI_ImportPreSelect_UI, VI_Import_UI, VI_JobSelect_ui, VI_Log_UI

Properties

PROPERTY ViewOnly  
PROPERTY ScriptsDefined   * Read Only *
PROPERTY DocDateWarnDisplayed   * Read Only *

[boolean] Property to track whether Document Date Warning message was displayed

PROPERTY DocDateWarnForceOff   * Read Only *

[boolean] Property used to temporarily disable display of Document Date Warning message

Methods

FUNCTION CallScript(lib$, panel$, folder$, control$, cmdStr$, scriptRawProc$)  

The function called by *winproc to run Customizer UI scripts if any are defined.

ParameterDescription
[input, string] Library Name
[input, string] Panel Name
[input, string] Folder Name
[input, string] Control Name
[input, string] *winproc CMD_STR$. Ex: "_X_ = _OBJ'POSTLOADPHEADER()", "_X_ = _OBJ'CHANGEML_Customer()", "_X_ = _OBJ'BT_ACCEPT()"
[input, string] Pre-parsed, raw script procedure - if available - will shortcut the parsing of CMD_STR$

@ returns [numeric]

ValueDescription
Success (1)
Failure (0)
FUNCTION ClassFormatterDate$(ID, val$, col$, col, row)  
FUNCTION ClassFormatterDate$(ID, val$, col$)  
FUNCTION ClassFormatterTime$(ctlID, val$, col$, col, row)  
FUNCTION ClassFormatterTime$(ctlID, val$, col$)  
FUNCTION ClassFormatterUdfYesNo$(ID, val$, col$, col, row)  
FUNCTION ClassOnfocusDate(ID)  
FUNCTION ClassPushCreditRptPush(ID)  
FUNCTION ClassPushDeliveryOptionsPush(ID)  
FUNCTION ClassPushEmailPush(ID)  
FUNCTION ClassPushExecute(seedVal$, default$, opts$)  
FUNCTION ClassPushExecute(seedVal$, default$, opts$, perCentOK)  
FUNCTION ClassPushExplorerView(ID)  
FUNCTION ClassPushHyperlinkPush(ID)  
FUNCTION ClassPushMapPush(ID)  
FUNCTION ClassPushPkgTrackingPush(ID)  
FUNCTION ClassPushURLPush(ID)  
FUNCTION ClassValidateDate$(ID, val$, col$, col, row)  
FUNCTION ClassValidateDate$(ID, val$, col$)  
FUNCTION ClassValidateDocumentDate(ID, val$, bOverride)  

verify date value is within allowed range, if specified for field

ParameterDescription
ID [in, int] Control ID for current field
val$ [in/out, string] date value to be verified
bOverride [in, boolean] Allow user to override date outside allowed range
Returns [boolean] retSUCCESS (1) if date value is in the allowed range, or entered value was accepted
Returns [boolean] retFAILURE (0) if value is not a date or was outside allowed range and was not accepted
FUNCTION ClassValidateUdfYesNo$(ID, val$, col$, col, row)  
FUNCTION DropBoxLoad(dropBoxName$, value$, delimiter$)  
FUNCTION DropBoxLoad(dropBoxName$, value$)  

Loads or reloads a drop box with the given delimited list of values.

ParameterDescription
dropBoxName$ [input, string] Object/variable name of the drop box to load.
value$ [input, string] Panel Delimited list of values to be loaded into the drop box. Must include trailing delimiter.
delimiter$ [input, string] {Optional} Optionally specifiy the character used to delimit the load value.
Returns [boolean] retSUCCESS (1) if the drop box was loaded successfully.
Returns [booelan] retFAILURE (0) if an error occurred and the drop box was not loaded correctly.
FUNCTION FormatNumericTime(numericTime, formattedTime$)  
FUNCTION FormatNumericTime(numericTime, formattedTime$, mask$)  
FUNCTION GetControlProperty(control$, prop$, value$)  

Retrieve the value of a NOMADs control property through custom scripting.

ParameterDescription
control$ [input, string] Name of the control to retrieve property information.
prop$ [input, string] Name of property to retrieve value for.
value$ [output, string] Value of property for control for being queried.
Returns [boolean] retSUCCESS (1) if property value was returned.
Returns [booelan] retFAILURE (0) if control does not exist or if property does not exist for the control.
FUNCTION GetDateMasked(inDate$, outDate$)  
FUNCTION GetDateRaw(inDate$, outDate$)  
FUNCTION GetFolderName$()  
FUNCTION GetPanelName$()  
FUNCTION GetScreenName$()  
FUNCTION GetValue(var$, val$)  
FUNCTION GetValue(var$, val)  
FUNCTION HandleScriptUI()  
FUNCTION HandleScriptUI(oScript)  
FUNCTION InvokeChange(var$, val)  
FUNCTION InvokeChange(var$, val$)  
FUNCTION InvokeChange(var$, val, grid$)  
FUNCTION InvokeChange(var$, val$, grid$)  
FUNCTION InvokeLookup(code$, value$)  
FUNCTION InvokeLookup(code$, value$, startValue$)  

Function will invoke the ALE lookup given in the first argument. The user can then select something from the list and the return value will be passed back in the value argument.

ParameterDescription
[input, string] Pass in the ALE lookup code to be displayed.
[output, string] Value selected from the lookup, if the lookup is cancelled this string will be empty.
[input, string] {optional} Optionally you can pass in a starting value for the filter. This would be used for lookups where there is a multi-segmented key. For example, the customer contact lookup where you pass in the customer number.
Returns [boolean]
ValueDescription
Success (1), if lookup value was returned.
Failure (0), if an invalid lookup or the lookup dialogue was cancelled and no selection made.
FUNCTION ListBoxLoad(listBoxName$, value$, delimiter$)  
FUNCTION ListBoxLoad(listBoxName$, value$)  

Loads or reloads a list box with the given delimited list of values.

ParameterDescription
listBoxName$ [input, string] Object/variable name of the list box to load.
value$ [input, string] Panel Delimited list of values to be loaded into the list box. Must include trailing delimiter.
delimiter$ [input, string] {Optional} Optionally specifiy the character used to delimit the load value.
Returns [boolean] retSUCCESS (1) if the list box was loaded successfully.
Returns [booelan] retFAILURE (0) if an error occurred and the list box was not loaded correctly.
FUNCTION Process(*)  

Method override to provide place to check for Customizer UI scripted events

ParameterDescription
[input, string] Optional 20 string parameters (ARG_1$ through ARG_20$)
Returns [numeric]
ValueDescription
Success (1)
FUNCTION SetControlProperty(control$, prop$, value$)  

Sets a property value to a NOMADs control property through custom scripting.

ParameterDescription
control$ [input, string] Name of the control to set property information.
prop$ [input, string] Name of property to set the value for.
value$ [output, string] Value to set into the given property for the control
Returns [boolean] retSUCCESS (1) if property value was set successfully.
Returns [booelan] retFAILURE (0) if control does not exist or if property does not exist for the control.
FUNCTION SetDocDateWarnOff(bDisable)  

Set state of property used for to temporarily disable display of message for Document Date Warning @property bDisable [input, boolean] TRUE = Disable message display, FALSE = Display message, if feature enabled

Returns retSUCCESS(1)
FUNCTION LOCAL AppendTitleBar()  
FUNCTION LOCAL AppendTitleBar(forceAppend)  

Append Title bar

ParameterDescription
forcAppend [input, numeric] forces title bar append when main dialogue is not DMain
Returns [boolean] always true
FUNCTION LOCAL BT_ListBoxExportToExcel()  

Export List Box Contents to Excel

Returns [boolean] retSUCCESS always returned.
FUNCTION LOCAL BT_SageU()  

Sage University training video access

Returns [boolean] always true
FUNCTION LOCAL CheckForScripts()  

Checks for scripts defined for the current Library (SCREEN_LIB$) and loads them into a Microsoft Script Control object.

Returns [boolean]
ValueDescription
True (1), if scripts are defined for the current Library.
False (0), if no scripts are found for the current Library.
FUNCTION LOCAL ClassChangeTelephoneNoUI(ctlNum)  
FUNCTION LOCAL ClassPushDirectoryButton(controlID)  

Associated with the DirectoryButton Class Button adjacent to Multiline Will Display Browse for Folder Dialog Button needs the following user Tag "DirectoryVarName=varName$" Name of MultiLine

Returns [boolean] always true
FUNCTION LOCAL DrillDown(program$, key$)  
FUNCTION LOCAL DrillDown(program$, key$, preserveObj, objHandle)  
FUNCTION LOCAL GetListboxIol$(ctlID)  
FUNCTION LOCAL GetListboxIol$(ctlID, refresh)  
FUNCTION LOCAL GetListboxIol$(ctlID, refresh, skipColumns$)  
FUNCTION LOCAL GetScriptUIGroup$(tmpCtlList$)  
FUNCTION LOCAL InitScriptEngine()  

This function runs once, the first time CallScript() is called. It sets up the *proxy objects to the Microsoft Script Control object, and runs the Customizer "INIT" script if one is defined.

Returns [numeric]
ValueDescription
Success (1)
FUNCTION LOCAL NomadsProcess(*)  
FUNCTION LOCAL ParseTagField(field$, value$)  
FUNCTION LOCAL ParseTagField(field$, value$, tag$)  
FUNCTION LOCAL SetControlState(group$, action)  
FUNCTION LOCAL SetControlState(group$, action$)  
FUNCTION LOCAL SetKeyState(action)  
FUNCTION LOCAL ShowDocumentDateWarning(errNum$, errMsg$, colDesc$, var$, dateEntered$, bOverride)  

Display error message and handle user repsonse for document date warning

ParameterDescription
errNum$ [input, string] Error message code to display
errMsg$ [input, string] Message text to be displayed that corresponds with the message code.
colDesc$ [input, string] column description for validated field
var$ [input, string] Variable associated with the validated field
dateEntered$ [input, date] Date entered in validated field
bOverride [in, boolean] Allow user to override date outside allowed range
Returns [boolean] retSUCCESS (1) if date value is in the allowed range, or entered value was accepted
Returns [boolean] retFAILURE (0) if value is not a date or was outside allowed range and was not accepted
FUNCTION LOCAL ShowSageUniversity()  

Shows Sage U button if task has the button and a URL exists for the task

Returns [boolean] True = button is shown, False = button remains hidden
FUNCTION LOCAL Status()  

Properties inherited from: SY_Constant

retFAILURE, retSUCCESS, retNEW, retWARNING, retCANCEL, retYES, retNO, msgYES$, msgNO$, msgCANCEL$, msgOK$, msgRETRY$, msgABORT$, msgIGNORE$, msgNOTONFILE$, msgTIMEOUT$, msgDISABLE, msgACTIVE, msgLinkHELP$, msgLinkMSG$, isFALSE, isTRUE, isYES$, isNO$, isBUSY$, edtNONE, edtEXISTS, edtNEW, ctlDISABLE, ctlENABLE, ctlSHOW, ctlHIDE, ctlLOCK, ctlUNLOCK, ctlLOCKORDISABLE, ctlUNLOCKORENABLE, popHIDE, popDISABLE, popSHOW, popSHOWCHECKED, grdMODEVIEW, grdMODEMAINT, grdMODEADD, filCREATE, filLOCK, filCREATELOCK, filGLOBAL, filCREATEGLOBAL, filLOCKGLOBAL, filCREATELOCKGLOBAL, filCHANNEL, filRAW, filPURGE, filLOAD, filINPUT, filNOOBJECT, filPVX, filREFRESH, filPVX4$, filPVX5$, pthCOMPANY$, pthOTHERCOMPANY$, pthPRCOMPANY$, pthOTHERPRCOMPANY$, pthSYSTEM$, pthUSER$, pthSOA$, pthHOME$, pthROOT$, pthDICTIONARY$, pthTEXTOUT$, pthLOCK$, pthLOCKSYS$, pthPREFIX$, pthARCHIVE$, pthLOGFILES$, folderCOMMONPROGRAMFILES, folderCOMMONAPPLICATIONDATA, errOBJECT, errSYSTEMLOCK, errCONTINUE, errEMBEDDEDIO, errSYSLOCK, extSQLCREATETABLE$, extSQLALLOWNULLDATES$, dbALL$, dbNONE$, dateTOSTRINGFORMAT$, dateLONGMASK$, dateSHORTFMT, dateLONGFMT, dateYEARFIRST, dateMONTHFIRST, dateDAYFIRST, timeMINUTESMASK$, timeMINUTES24MASK$, timeSECONDSMASK$, timeSECONDS24MASK$, idxPRIMARY$, idxBATCH$, idxDISPLAY$, dirFIRST, dirLAST, dirNEXT, dirPREVIOUS, typALPHANUM, typZEROFILL, typCHARNUM, typMASTERNUM, typALPHANUMNF, typMASTERNUMC, typALPHA$, typNUMBERS$, typALPHANUM$, typALPHANUMNF$, typCHARNUM$, typMASTERNUM$, typMASTERNUMCLEN, modTASKOTFDISALLOW$, logALLACTIVITY$, logACTIVITY$, logERROR$, logACTNEWCUSTOMER$, logACTDATASYNC$, logACTDATAIMPORT$, logACTOPTIONCHANGED$, logACTPROGRAMLAUNCH$, logDFDM$, logSECURITY$, logTASKSCHEDULER$, logWEBERROR$, logVISUALINTEGRATOR$, logEntryIDLength, chkOFF$, chkON$, chkGRAYED$, secVIEWONLY, secCREATEONLY, secMODIFYONLY, secCREATEMODIFY, secDELETEONLY, secCREATEDELETE, secMODIFYDELETE, secFULLACCESS, secDEFAULTUSER$, secDEFAULTROLE$, regHKEY_CLASSES_ROOT, regHKEY_CURRENT_USER, regHKEY_LOCAL_MACHINE, regHKEY_USERS, regHKEY_CURRENT_CONFIG, regODBC_PATH$, regMAS_PATH$, E3_MYHANDLE, E3_TASK, E3_QUIT, E3_COCHANGE, E3_DATECHANGE, E3_USERCHANGE, E3_SRVRPATH, E3_HELPFILE, E3_TECHSUPPORT, E3_QUERYTOQUIT, E3_SUPERVISOR, E3_CUSTOMIZE, E3_SWITCHMODULE, E3_DISABLEWIN, E3_CURSOR, E3_USERID, E3_PRIVATETASK, E3_CHAT, E3_BROADCAST, E3_RELOAD, E3_PASSTHROUGH, E3_EXECUTE, E3_EXPCOCHANGE, E3_EXPTASK, E3_EXPLAUNCH, E3_SILENT, E3_DIRECT, E3_NODELIST, E3_OCXITEM, E3_MODULEID, E3_CUSTFAV, E3_HOMEPAGE, E3_MINIMIZE, E3_UNDOCKED, E3_DOCKED, E3_PUBLICTASK, E3_LAUNCHURL, E3_BTNCHANGE, E3_STDBTNRELOAD, E3_MYBUSINESS, E3_REGLOADED, E3_LOADED, E3_V4TASK, E3_PUBMODIFY, E3_TASKRELOAD, E3_SETAUTOHIDE, E3_COCHANGE2, E3_TASK_NC, E3_V4TASK_NC, E3_TASK_ALTC, E3_V4TASK_ALTC, E3_PASSWORD, E3_LAUNCHVIEW, E3_LAUNCHBIETASK, E3_CLEANUPBIE, E3_STARTVIEW, E3_BIE_ADMIN, E3_HELPPATH, E3_CUSTOMERID, E3_MASVERSION, E3_LAUNCHEMBEDDED, E3_LAUNCHERMENU, E3_APP_POINTSIZE, E3_LAUNCHERVERSION, E3_DISABLE, E3_ENABLE, E3_SHOW, E3_HIDE, E3_REFRESH, E3_LIBMASTER, WM_COPY, wtsINITIALPROGRAM, wtsAPPLICATIONNAME, wtsWORKINGDIRECTORY, wtsOEMID, wtsSESSIONID, wtsUSERNAME, wtsWINSTATIONNAME, wtsDOMAINNAME, wtsCONNECTSTATE, wtsCLIENTBUILDNUMBER, wtsCLIENTNAME, wtsCLIENTDIRECTORY, wtsCLIENTPRODUCTID, wtsCLIENTHARDWAREID, wtsCLIENTADDRESS, wtsCLIENTDISPLAY, wtsCLIENTPROTOCOLTYPE, thmNORMAL, thmMETAL, thmOLIVE, rptREPORTTYPESTD, rptREPORTTYPELABEL, rptREPORTTYPEMULTCOL, rptISTRUE, rptISFALSE, rptISDEFAULT, rptPORTRAIT, rptLANDSCAPE, rptASCENDING, rptDESCENDING, rptRIGHTALIGN, rptLEFTALIGN, rptHORCENTERALIGN, rptLSSINGLELINE, rptSTSUM, rptSTAVERAGE, rptSTCOUNT, rptDFLTHSPACING, rptDFLTVSPACING, rptDFLTFONTSIZE, rptDFLTLEFT, rptDFLTTOP, rptTWIPSPERCHARW, rptTWIPSPERCHARH, rptSVTREPORTTITLE, rptEDTDISKFILE, rptGCANYVALUE, rptGCDAILY, rptCRDATEFIELD, rptCRDATETIMEFIELD, crEFTCrystalReport, crEFTRichText, crEFTWordForWindows, crEFTExcel, crEFTPortableDocFormat, crEFTHTML32, crEFTHTML40, crEFTExcelRecord, crEFTText, crEFTCharacterSeparatedValues, crEFTTabSeparatedText, crEFTEditableRTF, crEFTXml, crEFTRPTR, crEFTExcelWorkbook, cContextKeyLen1, cContextKeyLen2, cContextKeyLen3, adCmdText, adCmdStoredProc, adClipString, adExecuteNoRecords, adVarChar, adInteger, adParamInput, adParamOutput, adParamInputOutput, adParamReturnValue, adTextNoRecords, adOpenForwardOnly, adOpenStatic, adLockReadOnly, adUseServer, adUseClient, dbTMP$, dbTEMPDB$, dbSYSDB$, dbPVXDDF, dbPVXDB, dbMYSQL, dbADO, dbSQL, LastErrorMsg$, LastErrorNum$, SageCloudAppDesc$, IolNomads$

Methods inherited from: SY_Constant

GetNOMADSIolist$(), MaskString(), RawString(), ClassValidateEMailAddress(), dateTODAY$(), Element$(), fmtMODCODE$(), fmtMODPREFIX$(), PERFORM FunctionBreak(), GetExceptionMsg$(), GetFileName(), GetJobTitles(), GetPrinterProps(), GetRecordCount(), isALPHA(), isDATE(), isNUMERIC(), MsgPath$(), ParseString(), ParseTagField(), Position(), QUO$(), ValidateFormatType(), ZeroFill$()