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 cWebApp
AddResponseAttachment Function Adds an attachment to the response cWebApp
AllowViewAccess Function cWebApp
AppSynching Function 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 cWebApp
ClientResize Procedure Forces a full resize on the client cWebApp
ClientTranslations Function 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 cWebApp
CurrentView Function Determines the currently shown view 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 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 cWebApp
GetDefaultView Function Returns a handle to the application's default view cWebApp
GetLoginView Function Returns a handle to the login view cWebApp
GetReportsCache Function Returns the web application's Report Cache directory cWebApp
HistoryPushState Procedure 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) cWebApp
Host Function Returns a Handle to the Host object of this web object cWebApp
IgnoreError Procedure 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 cWebApp
IsViewInSync Function 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 cWebApp
LogEvent Procedure 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 cWebApp
NavigateRefresh Procedure Reloads 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 cWebApp
ParseViewStateHash Procedure 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 cWebApp
RestoreState Procedure Restores the based on the passed state hash cWebApp
ServerVariable Function Allows retrieval of IIS Server Variable values cWebApp
SetCookie Procedure Used to update a cookie key cWebApp
SetPageTitle Procedure Sets the page's HTML title element dynamically cWebApp
SetStateHash Procedure Changes the currently active state hash cWebApp
ShowInfoBox Procedure Displays a modal information dialog with a message and a caption cWebApp
ShowMessageBox Procedure Displays a web message box cWebApp
ShowYesNo Procedure Displays an information dialog with Yes and No buttons cWebApp
ShowYesNoCancel Procedure Displays an information dialog with Yes, No and Cancel buttons cWebApp
StartWebApp Procedure Starts a web application cWebApp
StateHash Function Returns the currently active state hash cWebApp
StateHashToUrl Procedure Called to convert a state hash into a URL cWebApp
TrapAllErrors Procedure Hook to trap all errors cWebApp
TrapError Procedure 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 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 cWebApp

Inherited Methods from cWebBaseUIObject

Name Type Description Defining Class
AddKeyHandler Procedure Adds a client side key handler 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 cWebBaseUIObject
DropData Function Returns the DragData for this control cWebBaseUIObject
Focus Procedure Gives the control the focus cWebBaseUIObject
IsControlAccessible Function 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 cWebBaseUIObject
IsControlVisible Function Determines if a control is visible cWebBaseUIObject
RemoveKeyHandler Procedure Removes a client side key handler cWebBaseUIObject
ScrollIntoView Procedure Scrolls an object that is currently scrolled out of the view 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 cWebObject
ClientAction Procedure Calls a function of the client JavaScript object cWebObject
ClientActionEx Procedure 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 cWebObject
Host Function Returns a Handle to the Host object of this web object cWebObject
InitDynamicProp Procedure Sets a dynamic property value cWebObject
IsDynamicObject Function 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 cWebObject
NavigatePath Procedure Performs the navigation registered for this web object cWebObject
ptActionData Function Retrieves the action data for a server action as value tree cWebObject
ResourceManager Function Returns handle to the cWebResourceManager object cWebObject
ServerPropStore Function Returns handle to the cWebServerPropStore object cWebObject
ServiceDispatcher Function Returns handle to the cWebServiceDispatcher object cWebObject
SessionManager Function Returns 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 cWebObject
ViewStack Function Returns handle to the cWebViewStack object cWebObject
WebMethodByName 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 cWebObject
WebMethodName Function 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 cWebObject
WebObjectName Function 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 cObject
ClassSuperClass Function Returns the superclass of the passed class cObject
Create Function Creates an object based on the passed Class Id cObject
CreateNamed Function 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 cObject
Exit_Application Procedure Starts the process of closing an application 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 cObject
ObjectClass Function Returns the integer class ID assigned to the class this object is based on cObject
Request_Destroy_Object Procedure Use the Destroy method instead cObject