ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WEBDEV concepts / Part 9 - Appendices
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
1. WLanguage functions specific to WEBDEV
Previous pageTable of contentsNext page
AddFavoriteAdds an Internet address into the list of favorites for the Web user.
AJAXAsynchronousCallPendingUsed to find out whether a server procedure called by AJAXExecuteAsynchronous is currently run.
AJAXAvailableUsed to find out whether the AJAX technology is supported by the current browser.
AJAXCancelAsynchronousCallCancels the automatic execution of the browser procedure called by AJAXExecuteAsynchronous.
AJAXExecuteRuns a server procedure without refreshing the page.
AJAXExecuteAsynchronousRuns a server procedure without refreshing the page.
AppServerAddScheduledTaskAdds a new scheduled task to the application (site or webservice).
AppServerDeleteScheduledTaskDeletes a scheduled task associated with the application (site or Webservice).
AppServerInfoScheduledTaskReads the description of a scheduled task.
AppServerListScheduledTaskReturns the list of scheduled tasks for the application (site or Webservice).
AppServerModifyScheduledTaskModifies an existing scheduled task.
AppServerRunScheduledTaskImmediately starts the execution of a scheduled task on a WEBDEV Application Server.
ASPDisplayCalls an external ASP script and returns the result page in the current browser window.
ASPExecuteCalls an external .asp script and returns the result in a string.
BannerFirstDisplays the first plane of a Sliding Banner control.
BannerNextDisplays the next plane of a Sliding Banner control.
BannerPreviousDisplays the previous plane of a Sliding Banner control.
BannerStopSlidingStops the automatic slide on a Sliding Banner control.
BreadcrumbAddLinkAdds a link into a Breadcrumb control.
BreadcrumbDeleteAllDeletes all links from a Breadcrumb control.
BreadcrumbDeleteLinkDeletes a link from a Breadcrumb control.
BreadcrumbInsertLinkInserts a link into a Breadcrumb control.
BreadcrumbModifyLinkModifies a link in a Breadcrumb control.
BrowserCloseCloses the current browser window and stops the execution of the current code.
BrowserHeightReturns the height (in pixels) of the client area where the page is displayed.
BrowserHistoryAddAdds an entry into the history of navigation by associating data. This data will be transmitted when going back to this entry.
BrowserHistoryModifyModifies the data of current entry in the navigation history. This data will be transmitted when going back to the current entry.
BrowserIPAddressReturns the IP address of the client computer connected to the WEBDEV site.
BrowserIsConnectedIndicates whether the browser is connected to the network.
BrowserMobileAllows you to find out whether the browser used by the Web user is started on a mobile device.
BrowserNameReturns the name of the browser of the Web user ("user agent").
BrowserOpenOpens a web page identified by its URL in a new browser.
BrowserOSIndicates the operating system installed on the browser of the Web user.
BrowserPlatformReturns the user's browser platform.
BrowserPrintPrints the page currently displayed in the browser.
BrowserRunAppOpens the default Web browser of the current device.
BrowserSliceReturns the number of the slice displayed in a page in Responsive Web Design mode.
BrowserTypeReturns the type of browser used by the Web user.
BrowserVersionReturns the version of the browser used by the Web user.
BrowserWidthReturns the width (in pixels) of the client area where the page is displayed.
CancelAWPContextDeletes from the AWP context a variable that was added by DeclareAWPContext.
CapsLockVerifyChecks whether the CapsLock key is pressed.
CaptchaDisplayDisplays a new Captcha in a Captcha control.
CaptchaVerifyChecks whether the value typed by the user corresponds to the string displayed in a Captcha control.
CellCloseDialogHides a Cell control previously displayed in the page via CellDisplayDialog.
CellDisplayDialogDisplays a Cell control in a page with a DDW effect (Dim Disabled Windows). This function is used to easily simulate a dialog box in browser code, by using a Cell control in a page.
CertificateClientInfoReturns information about the certificate used by the client computer.
ChangeActionUsed to specify the action to perform when the HTML page displayed in the browser is no longer synchronized with the page context on server.
ChangeTargetChanges the target of a button action.
ColorPaletteReturns a color found in the current palette.
ConfigureAWPContextConfigures the operating mode of the AWP context.
ConnectionCountReturns the number of instances of the WEBDEV site currently run on the server.
ContextCloseCloses a page context.
ContextExistAllows you to find out whether a page context exists on the server (which means whether the page was opened).
ContextOpenOpens a new page context without returning the information to the browser.
CookieReadRetrieves the value of a cookie saved on the computer of Web user.
CookieWriteWrites a cookie onto the computer of the Web user.
CurrentPageReturns the name of the page containing the WLanguage code currently run.
DeclareAWPContextUsed to declare a list of variables whose value will be persistent between the successive displays of Active WEBDEV Pages.
DynamicServingConfigureIndicates the environment that will be used by the "Dynamic Serving" to choose the set of pages to display.
DynamicSiteDisplayStarts a dynamic WEBDEV site from a static page or or from a dynamic WEBDEV page.
EmailOpenMailOpens the default messaging software:
  • of Web user on the browser computer.
  • of the user on the current Windows computer.
  • on the phone.
EmailStatusReturns the status of an email sent via an SMTP session started in asynchronous mode.
ExecuteDelayedProcedureRuns a delayed procedure (in the WEBDEV application server).
fCopyFileWebFolderCopies an image file from the data directory of application (or from one of its sub-directories) to the "_WEB" directory of application (or to one of its sub-directories).
fDeleteFileWebFolderDeletes an image file from the "_WEB" directory of the application (or from one of its sub-directories).
FileDisplayDisplays a file in the user's browser.
FileToPageAutomatically updates the controls of a page with:
  • the values of the bound items in the current record (loaded in memory) of the data file described in the data model editor. This operation is performed regardless of the state of the controls (grayed, inactive or invisible).
  • the values of the bound WLanguage variables. This operation is performed regardless of the state of the controls (grayed, inactive or invisible).
FolderDataFolderData is kept for backward compatibility.
FolderWebReturns the path of the directory containing:
  • the images,
  • the JavaScript files,
  • the Java applet files,
  • the other files accessible from the browser.
FramesetDisplayDisplays a WEBDEV frameset in the user's browser.
FramesetUseDisplays a WEBDEV frameset in the user's browser and closes all the current page and frameset contexts.
FreeAWPContextFrees the AWP context in advance (on disk) to allow the other call on the same AWP context to be processed in parallel.
FullScreenDisableDisables the "Full screen" mode of browser.
FullScreenEnableSwitches the browser to "Full screen" mode. The browser occupies the entire screen.
fWebDirReturns the physical name of the directory containing the images, JavaScript files and Java files of the WEBDEV website.
GglAnalyticsAddEventAdds an event in Google Analytics
GglAnalyticsAddExceptionAdds an exception beside Google Analytics.
GglAnalyticsAddPageAdds a page beside Google Analytics.
GglAnalyticsAddSocialNetworkActionAdds a social network action beside Google Analytics.
GglAnalyticsAddTimingAdds a duration beside Google Analytics.
gpwOpenConfigurationOpens the User Groupware configuration window or page.
grImageSizeDefines the size of the image containing the chart.
HTMLClassAddAdds a class into the HTML classes of a control.
HTMLClassDeleteDeletes a class from the HTML classes of a control.
HTMLClassToggleToggles a class in the HTML classes of a control: if the class does not exist, it is added; if the class already exists, it is deleted.
IdentifierAWPContextReturns the identifier of AWP context.
iDirImageHTMLUsed to select the directory in which the images must be generated during a print in HTML format.
ImageAreaReturns the number of the image area clicked by the Web user.
ImageFirstDisplays the first image for the scroll.
ImageLastDisplays the last image for the scroll.
ImageNextDisplays the next image for the scroll.
ImageOccurrenceReturns the total number of images taken into account by the scroll.
ImagePreviousDisplays the previous image for the scroll.
ImageScrollingPositionReturns the displayed image.
ImageStartScrollingStarts cycling through images.
ImageStopScrollingStops the automatic image sliding.
ImageXPosReturns the horizontal position (X) of the mouse cursor in relation to the specified Image control.
ImageYPosReturns the vertical position (Y) of the mouse cursor in relation to the specified Clickable Image control.
jQueryRuns a JavaScript method (or several chained methods) of the jQuery library on a page element.
jQueryExecuteRuns a JavaScript method of the jQuery library on a page element.
JSEndEventDeletes the association between a WLanguage browser function and an event (implemented by JSEvent).
JSEventAssociates a browser procedure with an event on an object in browser code.
JSInfoEventUsed to handle the JavaScript properties of the browser event that triggered the code execution.
JSInterruptEventInterrupts the process of current event.
JSMethodUsed to run a JavaScript method on an element found in the current page.
JSONExecuteCalls a server URL that returns data in JSON format (JavaScript Object Notation).
JSONExecuteExternalCalls an external server URL that returns data in JSON format (JavaScript Object Notation).
JSPropertyUsed to handle specific features on the objects found in the current page.
LocalStorageAddAdds a value to the local storage.
LocalStorageAvailableIndicates whether the local storage is available or not for the current browser.
LocalStorageDeleteDeletes a value from the local storage.
LocalStorageDeleteAllDeletes all the values from the local storage.
LocalStorageGetRetrieves a value from the local storage.
LocalStorageOccurrenceReturns the number of values for the local storage.
LocalStorageValueNameReturns the name of a value for the local storage.
LooperAddIPAdds a row as an internal page at the end of a Looper control populated programmatically.
LooperInsertIPInserts a row as an internal page into a Looper control populated programmatically.
LooperModifyIPModifies a row corresponding to an internal page in a Looper control populated programmatically.
MenuAddPopupTransforms a menu option of a page in order for this option to open a popup.
MenuAddURLOptionAdds a new option after the last option of a drop-down or context menu. This menu option opens the page that corresponds to the specified URL.
PageAddressUsed to find out the Internet address of a page.
PageChangeLayoutApplies a specific layout to a page.
PageCloseDialogCloses the current page. This page was opened by PageDisplayDialog. A return value can be returned to the calling page.
PageCurrentLayoutReturns the index of the current layout:
  • in the current page.
  • in the specified page.
PageDisplayDisplays a web page in the user's browser.
PageDisplayDialogDisplays a page in modal mode. This function is used to establish a dialog with the user. The page is displayed in the foreground while the opening page is displayed in the background, grayed by the DDW mechanism.
PageEnableDDWEnables or disables the DDW (Dim Disabled Window) when displaying a modal page (the pages used to communicate with the user for example).
PageExistChecks whether the specified page is currently displayed in the browser of the Web user. Used to find out whether a page is displayed in a frame other than the current one.
PageInitializationResets to zero (or not) the controls found in the current page and starts the events for initializing the controls and the page.
PageParameterReturns the value of a parameter passed to the current page.
PagePositionScrolls a page up to position a control in the visible section of the page (top) in the browser.
PageRateDDWAllows you to find out and modify the rate of gray for the pages that use DDW (Dim disabled pages).
PageReadHeaderHTTPReads and returns one or more HTTP headers received by the current page (these headers are sent by the client to the server in the current request).
PageRefreshRefreshes a page displayed in the user's browser from the context on the server.
PageSubmitValidates the specified page and starts the execution of a button.
PageToASPSends the data found in a page currently displayed in the browser to an ASP server.
PageToEmailEmails the data found in a page currently displayed in the browser.
PageToFileAutomatically updates:
  • the value of the items in a data file with the value of the controls in the page. The data file items bound to the window controls are automatically updated with the values of these controls.
  • the value of the WLanguage variables with the value of the window controls. The WLanguage variables bound to the page controls are automatically updated with the values of these controls.
This operation is performed regardless of the state of the controls (grayed, inactive or invisible).
PageToJSPSends the data found in a page currently displayed in the browser to a JSP server.
PageToPHPSends the data found in a page currently displayed in the browser to a PHP server.
PageToSourceAutomatically updates:
  • the value of the items in a data file with the value of the controls in the page.
  • the value of the WLanguage variables with the value of the page controls.
PageUseDisplays a WEBDEV page in the user's browser and closes all page contexts currently open on the server.
PageVisibleIndicates whether the page is visible to the user.
PageWriteHeaderHTTPAdds an additional HTTP header that will be returned to the browser:
  • during the next function for page display (PageDisplay, PageRefresh, ...),
  • during the automatic return of the current page at the end of the current action.
PHPDisplayCalls an external PHP script and returns the result page in the current browser window.
PHPExecuteCalls an external .php script and returns the result in a string.
PopupAnimateDisplays a popup in a page cell.
PopupCloseHides a popup displayed in the page via PopupDisplay.
PopupClosePageHides a page displayed as a popup via PopupDisplayPage.
PopupDisplayDisplays a popup in a page with a DDW effect (Dim Disabled Windows).
PopupDisplayPageDisplays a WEBDEV page as a popup in the current page with a DDW (Dim Disabled Windows) effect.
PreviousPageReturns the name of the previous page.
ProgressBarDisableStops the periodic refresh of a Progress Bar via Ajax.
ProgressBarEnableEnables the refresh of a Progress Bar via Ajax.
ProgressBarExecuteStarts a long browser process and fill a Progress Bar via Ajax according to the progress of this process.
rssDisplayBuilds a RSS stream and returns the content of the RSS stream to the client.
SaaSCheckServiceChecks the access rights of the user to a service of the SaaS site.
SaaSClientConnexionReturns the characteristics of the connection to the client database.
SaaSConnectAuthenticates a user of a SaaS site beside the SaaS webservice that manages the site.
SaaSConnectedUserReturns the user currently connected via SaaSConnect.
SaaSDisconnectDisconnect the user of a SaaS site beside the SaaS web service that manages the site.
SaaSIsConnectedDefines whether the connection to the SaaS web service is still established.
SaaSReadSiteParameterReads an information specific to the client for the current SaaS site.
SaaSWriteSiteParameterSaves a specific information for a SaaS site in the configuration of a client account.
ScriptDisplayCalls an external script or page (.php, .asp, .mhtml or.mht) and returns the result page in the current browser window.
ScriptExecuteCalls an external script (.asp or .php) and returns the result in a string.
SessionPrologueEnables or disables a WLanguage procedure called on each request in a session.
SessionRequestedPageReturns the name of the page requested at the start of the session.
SiteAddressReturns the Internet address for connecting to a dynamic WEBDEV site (in Session mode) found on the same server.
SourceToPageAutomatically updates the controls of a page with:
  • the values of the bound items in the current record (loaded in memory) of the HFSL data file described in the data model editor.
  • the values of the bound WLanguage variables.
SSLActiveUsed to enable or disable the secure SSL mode.
StringDisplayReturns a specific string (or a buffer) to the client browser in response to a request.
SysVersionReturns information about the PHP version used on the current server.
ToastDisplayPopupDisplays a popup page during a given duration in order to display a "Toast" message.
UploadCopyFileSaves on the server a file "uploaded" by the Web user. This upload may have been performed:
  • via an "Upload" edit control.
  • via a single-file or multi-file Upload control.
UploadCurrentFileIndicates the file currently uploaded via the Upload control.
UploadCurrentFileSizeReturns the total size (in bytes) of the file currently uploaded via an Upload control.
UploadCurrentFileSizeSentReturns the size (in bytes) already sent for the file currently uploaded via an Upload control.
UploadDeleteDeletes a file from the list of files to upload: the file will not be uploaded on the server.
UploadDeleteAllClears the list of files to upload: no file will be uploaded on the server.
UploadFileNameReturns the name of a file "uploaded" by the Web user. This upload may have been performed:
  • via an "Upload" edit control.
  • via a single-file or multi-file Upload control.
UploadFileSizeReturns the total size (in bytes) of a file found in an Upload control.
UploadSizeReturns the total size (in bytes) of the file currently uploaded via an Upload control.
UploadSizeSentReturns the total size (in bytes) of files already sent by the current upload via an Upload control.
UploadStartStarts sending the selected files into an Upload control.
Previous pageTable of contentsNext page
Comments
Click [Add] to post a comment

Last update: 09/14/2023

Send a report | Local help