Skip to content

Methods for cWebApp

View method list in alphabetical order.

Name Type Description Defining Class
AddChangeRightsClient Procedure cWebApp
AddHttpResponseHeader Procedure Sets a specific response header Sets a specific response header. cWebApp
AddResponseAttachment Function Adds an attachment to the response Adds an attachment to the response and returns the integer id of the attachment. cWebApp
AllowViewAccess Function cWebApp
AppSynching Function Returns True if the application is in an initializing state Returns True if the application is in an initializing state. cWebApp
Call_PreSync Procedure cWebApp
ClientLog Procedure Displays a diagnostic string on the client's JavaScript debugging console ClientLog shows the provided text on the console of a JavaScript debugger (such as FireBug). cWebApp
ClientResize Procedure Forces a full resize on the client This client action forces a full resize on the client, making sure that all dimensions are recalculated. cWebApp
ClientTranslations Function Returns translations in an array of name value structs Returns translations in an array of name value structs. cWebApp
ConcatViewStateHash Function Concatenates the different parts of a view state hash into a single view state hash string Concatenates the different parts of a view state hash into a single view state hash string. cWebApp
CurrentView Function Determines the currently shown view Determines the currently shown view (cWebView). cWebApp
DEOControlFocusObject Function Returns the object handle of the object representing the currently focused control on the client if the control supports the full data binding interface cWebApp
DEOFocusObject Function Returns the object handle of the object representing the currently focused control on the client if the control supports the data entry object interface cWebApp
DoDetachAllTables Procedure Clears the contents of all open tables, except system tables Clears the contents of all open tables, except system tables. cWebApp
FindWebObject Function cWebApp
FindWebObjectSilent Function cWebApp
FocusObject Function Returns the object handle of the object representing the currently focused control on the client cWebApp
ForcedInitialView Function cWebApp
GetCookie Function Reads a cookie key GetCookie reads a cookie key using its name directly from the HTTP Header. cWebApp
GetDefaultView Function Returns a handle to the application's default view This function returns the default view's object handle. cWebApp
GetLoginView Function Returns a handle to the login view This function returns the login view's object handle. cWebApp
GetReportsCache Function Returns the web application's Report Cache directory Returns the full file path of the standard Reports Cache folder of the current workspace. cWebApp
HistoryPushState Procedure Pushes a new history item to the history stack Pushes a new history item to the history stack. cWebApp
HistoryReplaceState Procedure Replaces the top level item on the history stack (so no new history item is added) Replaces the top level item on the history stack (so no new history item is added). cWebApp
Host Function Returns a Handle to the Host object of this web object Returns a Handle to the Host object of this web object. cWebApp
IgnoreError Procedure Hook to ignore a specific error number Hook to ignore a specific error number. cWebApp
Initializing Function Determines whether the WebApp host (cWebApp or cLocalWebAppHost) is still initializing (objects are being created and initialized) cWebApp
IsLoaded Function Checks whether the web objects in this scope are loaded to the client Determines whether the web objects in this scope are loaded to the client. cWebApp
IsViewInSync Function Determines if a view is in sync Determines if a view is in sync. cWebApp
IsViewLoaded Function Determines if a view is loaded on the client cWebApp
LogErrorEvent Procedure Logs an error event LogErrorEvent logs an error event. cWebApp
LogEvent Procedure Logs an event to the Web Application's event log LogEvent logs an event to the Web Application's event log. cWebApp
NavigateNewWindow Procedure Opens a URL in a new browser window with specified height and width. cWebApp
NavigatePathBegin Procedure Performs a NavigateBegin to the view passed as the first parameter Performs a NavigateBegin to the view passed as the first parameter. cWebApp
NavigateRefresh Procedure Reloads web application in the browser Send NavigateRefresh to reload your web application in the browser. cWebApp
NavigateToPage Procedure Opens a URL in a new browser tab, a new browser window or replaces your web application cWebApp
NavigateToStateHash Procedure Can be called to manually restore a specific application state This procedure can be called to manually restore a specific application state. cWebApp
ParseViewStateHash Procedure Parses a view state hash into the different pieces that make up one Parses a view state hash into the different pieces that make up one. cWebApp
RegisterOnCallEndEvent Procedure cWebApp
RemoveChangeRightsClient Procedure cWebApp
RemoveOnCallEndEvent Procedure cWebApp
RequestAttachment Function Retrieves an attachment from the request based on its index Retrieves an attachment from the request based on its index. cWebApp
RestoreState Procedure Restores the based on the passed state hash Restores the based on the passed state hash. cWebApp
ServerVariable Function Allows retrieval of IIS Server Variable values Allows retrieval of IIS Server Variable values. cWebApp
SetCookie Procedure Used to update a cookie key SetCookie is used to update a cookie key's value and expiration time. cWebApp
SetPageTitle Procedure Sets the page's HTML title element dynamically By default, the page title (the text displayed in the browser's caption bar) of a Framework Web Application is hard coded in Index.html. cWebApp
SetStateHash Procedure Changes the currently active state hash This procedure changes the currently active state hash. cWebApp
ShowInfoBox Procedure Displays a modal information dialog with a message and a caption The ShowInfoBox message is used to display a message and title caption. cWebApp
ShowMessageBox Procedure Displays a web message box ShowMessageBox can display a great variety of custom web message boxes. cWebApp
ShowYesNo Procedure Displays an information dialog with Yes and No buttons The ShowYesNo message is used to handle yes/no confirmations. cWebApp
ShowYesNoCancel Procedure Displays an information dialog with Yes, No and Cancel buttons The ShowYesNoCancel message is used to handle yes/no/cancel confirmations. cWebApp
StartWebApp Procedure Starts a web application Starts a web application. cWebApp
StateHash Function Returns the currently active state hash This function returns the currently active state hash. cWebApp
StateHashToUrl Procedure Called to convert a state hash into a URL This procedure is called to convert a state hash into a URL. cWebApp
TrapAllErrors Procedure Hook to trap all errors Hook to trap all errors. cWebApp
TrapError Procedure Hook to trap a specific error number Hook to trap a specific error number. cWebApp
UnloadView Procedure Removes a specific view or dialog from the client cWebApp
UploadFolder Function Determines the path to the default upload folder Returns the full file path of the standard Upload folder of the current workspace. cWebApp
UrlParameter Function Gets the value of a URL parameter that was passed with the web application URL when the web application was loaded cWebApp
ValidLogin Function Determines if a login is required to access the web application Call ValidLogin to test whether a login is required to access this web application. cWebApp

Inherited Methods from cWebBaseUIObject

Name Type Description Defining Class
AddKeyHandler Procedure Adds a client side key handler It is possible to assign custom key handlers to controls and containers. cWebBaseUIObject
ConditionalFocus Procedure Gives the control the focus but only if the browser platform is not a mobile device (tablet / phone) cWebBaseUIObject
DragData Function Returns the DragData for this control Returns the DragData for this control, set by the active cWebDragDropHelper object. cWebBaseUIObject
DropData Function Returns the DragData for this control Returns the DragData for this control, set by the active cWebDragDropHelper object. cWebBaseUIObject
Focus Procedure Gives the control the focus Gives the control the focus. cWebBaseUIObject
IsControlAccessible Function Determines if the control is currently accessible Determines if the control is currently accessible. cWebBaseUIObject
IsControlEnabled Function Determines if a control is enabled cWebBaseUIObject
IsControlRendered Function Determines if a control is rendered Determines if a control is rendered (if pbRender is True of itself and its parents). cWebBaseUIObject
IsControlVisible Function Determines if a control is visible Determines if a control is visible (if pbVisible is True of itself and its parents). cWebBaseUIObject
RemoveKeyHandler Procedure Removes a client side key handler It is possible to assign custom key handlers to controls and containers. cWebBaseUIObject
ScrollIntoView Procedure Scrolls an object that is currently scrolled out of the view into view Scrolls an object that is currently scrolled out of the view/hidden because the view has scrolled into view. cWebBaseUIObject

Inherited Methods from cWebObject

Name Type Description Defining Class
CallBack Procedure Use this procedure to delay a task to a new server round-trip Use this procedure to delay a task to a new server next round-trip. cWebObject
ClientAction Procedure Calls a function of the client JavaScript object Send ClientAction to call a function that belongs to the JavaScript object on the client that represents the DataFlex object. cWebObject
ClientActionEx Procedure Adds a client action to the response that will be executed on the client Adds a client action to the response that will be executed on the client. cWebObject
DEO_Object Function Determines if the object understands the DEO interface Determines if the object understands the data entry object (DEO) interface (is data-aware). cWebObject
Host Function Returns a Handle to the Host object of this web object Use this function to get a handle to the host for this Web Object. cWebObject
InitDynamicProp Procedure Sets a dynamic property value Sets a dynamic property value. cWebObject
IsDynamicObject Function Checks whether the object is dynamic or not Checks whether the object is dynamic or not. cWebObject
IsLoaded Function Checks if the webobject is loaded to the client cWebObject
NavigateInfo Function Returns array of navigation paths that the current object has registered Returns an array of navigation paths that the current object has registered. cWebObject
NavigatePath Procedure Performs the navigation registered for this web object Performs the navigation registered for this web object. cWebObject
ptActionData Function Retrieves the action data for a server action as value tree Retrieves the action data for a server action as value tree. cWebObject
ResourceManager Function Returns handle to the cWebResourceManager object Use this function to get a handle to the cWebResourceManager object. cWebObject
ServerPropStore Function Returns handle to the cWebServerPropStore object Use this function to get a handle to the cWebServerPropStore object. cWebObject
ServiceDispatcher Function Returns handle to the cWebServiceDispatcher object Use this function to get a handle to the cWebServiceDispatcher object. cWebObject
SessionManager Function Returns handle to the cWebSessionManager object Use this function get a handle to the cWebSessionManager object. cWebObject
SetActionMode Procedure Allows developer to configure a wait dialog for every server action cWebObject
UnSyncWebProperty Procedure Unsynchronizes a client web property Unsynchronizes a client web property. cWebObject
ViewStack Function Returns handle to the cWebViewStack object Use this function to get a handle to the cWebViewStack object used in drill-down applications. cWebObject
WebMethodByName Function Searches for the message handle of a message based on the name of a web method This function searches for the message handle of a message based on the name of a web method. cWebObject
WebMethodIsFunction Function Determines if a web method is a function or a procedure Use this function to determine if a web method is a function or a procedure. cWebObject
WebMethodName Function Converts the message handle of a web method into a string Converts the message handle of a web method into a string. cWebObject
WebObjectByName Function Searches for the object handle of a web object using its public name This function searches for the object handle of a web object using its public name. cWebObject
WebObjectName Function The public web object name of this object Returns the public web object name of this object. cWebObject

Inherited Methods from cObject

Name Type Description Defining Class
ChildByIndex Function Can be used to iterate the direct children of an object ChildByIndex is a function that can be used to iterate the direct children of an object. cObject
ClassSuperClass Function Returns the superclass of the passed class This returns the superclass of the passed class. cObject
Create Function Creates an object based on the passed Class Id The Create function is used to dynamically create objects. cObject
CreateNamed Function Creates an object based on the passed Class Id and assigns it a name Name based on a passed name Creates an object based on the passed Class Id and assigns it a name Name based on a passed name. cObject
Destroy Procedure Destroys the object that receives the message and any child objects of that object The Destroy message destroys the object that receives the message. cObject
Exit_Application Procedure Starts the process of closing an application The Exit_Application message is used to close the program. cObject
IsClassOfClass Function Determines whether the target class is part of the searched class's hierarchy cObject
IsObjectOfClass Function Determines whether the passed class is part of the object's class hierarchy This returns True if the passed class is part of the object's class hierarchy. cObject
ObjectClass Function Returns the integer class ID assigned to the class this object is based on Returns the integer class ID assigned to the class this object is based on. cObject
Request_Destroy_Object Procedure Use the Destroy method instead This method is used to destroy an object and all of its children. cObject