Methods for cWebApp

View method list in alphabetical order

NameTypeDescription
AddHttpResponseHeaderProcedureSets a specific response header
AddResponseAttachmentFunctionAdds an attachment to the response
AppSynchingFunctionReturns True if the application is in an initializing state
ClientLogProcedureDisplays a diagnostic string on the client's JavaScript debugging console
ClientResizeProcedureForces a full resize on the client
ClientTranslationsFunctionReturns translations in an array of name value structs
ConcatViewStateHashFunctionConcatenates the different parts of a view state hash into a single view state hash string
CurrentViewFunctionDetermines the currently shown view
DEOControlFocusObjectFunctionReturns the object handle of the object representing the currently focused control on the client if the control supports the full data binding interface
DEOFocusObjectFunctionReturns the object handle of the object representing the currently focused control on the client if the control supports the data entry object interface
DoDetachAllTablesProcedureClears the contents of all open tables, except system tables
FocusObjectFunctionReturns the object handle of the object representing the currently focused control on the client
GetCookieFunctionReads a cookie key
GetDefaultViewFunctionReturns a handle to the application's default view
GetLoginViewFunctionReturns a handle to the login view
GetReportsCacheFunctionReturns the web application's Report Cache directory
HistoryPushStateProcedurePushes a new history item to the history stack
HistoryReplaceStateProcedureReplaces the top level item on the history stack (so no new history item is added)
HostFunctionReturns a Handle to the Host object of this web object
IgnoreErrorProcedureHook to ignore a specific error number
InitializingFunctionDetermines whether the WebApp host (cWebApp or cLocalControlHost) is still initializing (objects are being created and initialized)
IsLoadedFunctionChecks whether the web objects in this scope are loaded to the client
IsViewInSyncFunctionDetermines if a view is in sync
IsViewLoadedFunctionDetermines if a view is loaded on the client
LogErrorEventProcedureLogs an error event
LogEventProcedureLogs an event to the Web Application's event log
NavigateNewWindowProcedureOpens a URL in a new browser window with specified height and width.
NavigatePathBeginProcedurePerforms a NavigateBegin to the view passed as the first parameter
NavigateRefreshProcedureReloads web application in the browser
NavigateToPageProcedureOpens a URL in a new browser tab, a new browser window or replaces your web application
NavigateToStateHashProcedureCan be called to manually restore a specific application state
ParseViewStateHashProcedureParses a view state hash into the different pieces that make up one
RequestAttachmentFunctionRetrieves an attachment from the request based on its index
RestoreStateProcedureRestores the based on the passed state hash
ServerVariableFunctionAllows retrieval of IIS Server Variable values
SetCookieProcedureUsed to update a cookie key
SetPageTitleProcedureSets the page's HTML title element dynamically
SetStateHashProcedureChanges the currently active state hash
ShowInfoBoxProcedureDisplays a modal information dialog with a message and a caption
ShowMessageBoxProcedureDisplays a web message box
ShowYesNoProcedureDisplays an information dialog with Yes and No buttons
ShowYesNoCancelProcedureDisplays an information dialog with Yes, No and Cancel buttons
StartWebAppProcedureStarts a web application
StateHashFunctionReturns the currently active state hash
StateHashToUrlProcedureCalled to convert a state hash into a URL
TrapAllErrorsProcedureHook to trap all errors
TrapErrorProcedureHook to trap a specific error number
UnloadViewProcedureRemoves a specific view or dialog from the client
UploadFolderFunctionDetermines the path to the default upload folder
UrlParameterFunctionGets the value of a URL parameter that was passed with the web application URL when the web application was loaded
ValidLoginFunctionDetermines if a login is required to access the web application

Inherited Methods from cWebBaseUIObject

AddKeyHandlerProcedureAdds a client side key handler
ConditionalFocusProcedureGives the control the focus but only if the browser platform is not a mobile device (tablet / phone)
DragDataFunctionReturns the DragData for this control
DropDataFunctionReturns the DragData for this control
FocusProcedureGives the control the focus
IsControlAccessibleFunctionDetermines if the control is currently accessible
IsControlEnabledFunctionDetermines if a control is enabled
IsControlRenderedFunctionDetermines if a control is rendered
IsControlVisibleFunctionDetermines if a control is visible
RemoveKeyHandlerProcedureRemoves a client side key handler
ScrollIntoViewProcedureScrolls an object that is currently scrolled out of the view into view

Inherited Methods from cWebObject

CallBackProcedureUse this procedure to delay a task to a new server round-trip
ClientActionProcedureCalls a function of the client JavaScript object
ClientActionExProcedureAdds a client action to the response that will be executed on the client
DEO_ObjectFunctionDetermines if the object understands the DEO interface
GetParentWidgetFunction
InitDynamicPropProcedureSets a dynamic property value
IsDynamicObjectFunctionChecks whether the object is dynamic or not
NavigateInfoFunctionReturns array of navigation paths that the current object has registered
NavigatePathProcedurePerforms the navigation registered for this web object
ptActionDataFunctionRetrieves the action data for a server action as value tree
SetActionModeProcedureAllows developer to configure a wait dialog for every server action
UnSyncWebPropertyProcedureUnsynchronizes a client web property
WebMethodByNameFunctionSearches for the message handle of a message based on the name of a web method
WebMethodIsFunctionFunctionDetermines if a web method is a function or a procedure
WebMethodNameFunctionConverts the message handle of a web method into a string
WebObjectByNameFunctionSearches for the object handle of a web object using its public name
WebObjectNameFunctionThe public web object name of this object

Inherited Methods from cObject

ChildByIndexFunctionCan be used to iterate the direct children of an object
ClassSuperClassFunctionReturns the superclass of the passed class
CreateFunctionCreates an object based on the passed Class Id
CreateNamedFunctionCreates an object based on the passed Class Id and assigns it a name Name based on a passed name
DestroyProcedureDestroys the object that receives the message and any child objects of that object
Exit_ApplicationProcedureStarts the process of closing an application
IsClassOfClassFunctionDetermines whether the target class is part of the searched class's hierarchy
IsObjectOfClassFunctionDetermines whether the passed class is part of the object's class hierarchy
ObjectClassFunctionReturns the integer class ID assigned to the class this object is based on
Request_Destroy_ObjectProcedureUse the Destroy method instead [Obsolete]