Methods for cLocalWebAppHost

View method list in alphabetical order

NameTypeDescription
ConcatViewStateHashFunctionConcatenates the different parts of a view state hash into a single view state hash string
CurrentViewFunctionDetermines the currently shown view
GetDefaultViewFunctionReturns a handle to the application's default view
IsViewInSyncFunctionDetermines if a view is in sync
IsViewLoadedFunctionDetermines if a view is loaded on the client
NavigatePathBeginProcedurePerforms a NavigateBegin to the view passed as the first parameter
NavigateToStateHashProcedureCan be called to manually restore a specific application state
ParseViewStateHashProcedureParses a view state hash into the different pieces that make up one
RestoreStateProcedureRestores the based on the passed state hash
SetStateHashProcedureChanges the currently active state hash
StateHashFunctionReturns the currently active state hash
StateHashToUrlProcedureCalled to convert a state hash into a URL
UnloadViewProcedureRemoves a specific view or dialog from the client
VirtualInitScriptFunctionGenerates the JavaScript executed during page load to initialize the WebApp framework

Inherited Methods from cLocalWebControlHost

HtmlPathFunctionDetermines the path to AppHtml
ReportFatalErrorProcedureCalled when a fatal error occurs while parsing a request received from the page
VirtualHtmlFunctionGenerates the HTML loaded into the control host
VirtualUrlFunctionGenerates the URL that is loaded within the browser instance

Inherited Methods from cBaseLocalControlHost

AddResponseAttachmentFunctionAdds an attachment to the response
AppSynchingFunctionReturns True if the application is in an initializing state
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
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
DEO_ObjectFunctionDetermines if the object understands the DEO interface
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
FocusObjectFunctionReturns the object handle of the object representing the currently focused control on the client
GetParentWidgetFunction
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
InitDynamicPropProcedureSets a dynamic property value
InitializingFunctionDetermines whether the WebApp host (cWebApp or cLocalControlHost) is still initializing (objects are being created and initialized)
IsDynamicObjectFunctionChecks whether the object is dynamic or not
IsLoadedFunctionChecks if the webobject is loaded to the client
NavigateInfoFunctionReturns array of navigation paths that the current object has registered
NavigateNewWindowProcedureOpens a URL in a new browser window with specified height and width.
NavigatePathProcedurePerforms the navigation registered for this web object
NavigateRefreshProcedureReloads web application in the browser
NavigateToPageProcedureOpens a URL in a new browser tab, a new browser window or replaces your web application
ptActionDataFunctionRetrieves the action data for a server action as value tree
RequestAttachmentFunctionRetrieves an attachment from the request based on its index
SetActionModeProcedureAllows developer to configure a wait dialog for every server action
SetPageTitleProcedureSets the page's HTML title element dynamically
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
UnSyncWebPropertyProcedureUnsynchronizes a client web property
UploadFolderFunctionDetermines the path to the default upload folder
ValidLoginFunctionDetermines if a login is required to access the web application
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 cWebView2Browser

AddScriptToExecuteOnDocumentCreatedProcedureAdds a script that will be executed during the loading of the future documents
AddScriptToExecuteOnDocumentCreatedFunctionAdds a script that will be executed during the loading of the future documents
AddWebResourceRequestedFilterProcedureSets up a resource request filter that will enable the OnWebResourceRequested for these requests
CapturePreviewProcedureCaptures the currently displayed document into an image
ClearVirtualHostNameToFolderMappingProcedureClears a virtual hostname mapping created using SetVirtualHostNameToFolderMapping
ExecuteScriptProcedureExecutes a script within the current top-level document of the WebView2 control
ExecuteScriptFunctionExecutes a script within the current top-level document of the WebView2 control
GoBackProcedureNavigates one step back in the browser history
GoForwardProcedureNavigates one step forward in the browser history
NavigateProcedureInitiates a browser navigation to the provided URL
NavigateToStringProcedureRenders the provided HTML as top-level document
OpenDevToolsWindowProcedureOpens the developer tools window
PostWebMessageAsJsonProcedurePosts a message to the document loaded inside the WebView2 control
PostWebMessageAsJsonHandleProcedurePosts a message to the document loaded inside the WebView2 control
PostWebMessageAsStringProcedurePosts a message to the document loaded inside the WebView2 control
ReloadProcedureReloads the current document
RemoveScriptToExecuteOnDocumentCreatedProcedureRemoves a script that is added using AddScriptToExecuteOnDocumentCreated
RemoveWebResourceRequestedFilterProcedureRemoves a resource request filter that was previously set up using AddWebResourceRequestedFilter
SetVirtualHostNameToFolderMappingProcedureCreates a virtual mapping between the provided host name and a local folder on disk
StopProcedureStops all navigations and pending resource fetches
WebMessageAdditionalFileObjectPathsFunctionCan be used to query file paths of additional file objects passed with a WebMessage
WebResourceRequestContentFunctionUse this function inside OnWebResourceRequested to query the HTTP request body of the current resource request
WebResourceRequestHeaderFunctionUse this function inside OnWebResourceRequested to query a specific HTTP header value of the current resource request
WebResourceResponseSetProcedureCan be used inside OnWebResourceRequested to set additional header values for the response.
WebResourceResponseSetHeaderProcedureUse inside OnWebResourceRequested to set additional HTTP headers on the response when overriding the response using WebResourceResponseSet

Inherited Methods from cComActiveXControl

Beginning_of_PanelProcedureGives the focus to the first item in the first object in the current parent-child hierarchy
Bottom_of_PanelProcedureActivates the last child object of this object that is a DEO, if any
DoHtmlHelpProcedureLaunches Compiled HTML Help
End_of_PanelProcedureGives the focus to the last item in the last object in the current parent-child hierarchy
Error_HelpProcedure[Obsolete]
Extended_HelpProcedure[Obsolete]
File_HelpProcedure[Obsolete]
HelpProcedureRequests Help. Usually invoked by pressing F1 or pressing a Button that sends this message
Help_For_HelpProcedure[Obsolete]
Help_IndexProcedure[Obsolete]
Help_on_TopicProcedure[Obsolete]
IsComObjectCreatedFunctionTests to see if a COM object exists by getting the value of IsComObjectCreated
Keys_HelpProcedure[Obsolete]
Next_Object_IdFunctionCalled by the switch message to determine the object_id of the next object to go to in the focus tree
Prior_Object_IdFunctionCalled by the switch_back message to determine the object_id of the previous object to go to in the focus tree
Request_Status_HelpProcedureSent when an object is about to take or lose the focus
ReSize_LabelProcedureCalled to resize the object's label after a font change
Switch_Next_AreaProcedureMoves the focus to the next "area" within a view
Switch_Prior_AreaProcedureMoves the focus to the previous "area" within a view
Top_of_PanelProcedureActivates the first child object of this object that is a DEO, if any; else activates this object

Inherited Methods from DfInPlaceComObject

ComAddRefProcedure
ComQueryInterfaceFunction
CreateComObjectProcedureSent to create and connect to an instance of the ActiveX control associated with this object
RegisterComEventProcedure
RegisterPropertyChangeEventProcedure
ReleaseComObjectProcedureReleases ActiveX control associated with this object

Inherited Methods from DfComUIObject

Adjust_LogicalsProcedureSets the logical coordinates for size and location to the best approximations of the actual physical coordinates of the object
DialogToGuiFunctionThis is used to convert dialog units to gui units.
GuiClientSizeFunctionThis returns an object's client area size as a folded integer value
GuiToDialogFunctionThis is used to convert gui units to dialog units.
GuiWindowSizeFunctionThis returns an object's outer window bounding size as a folded value
Release_Mouse_CaptureProcedureRestores normal mouse capture

Inherited Methods from cUIObject

ActivateProcedureGives an object the focus (and adds it to the focus tree)
Activate_ScopeProcedureActivates objects that are separate tools to the application
Add_FocusProcedureAdds the object into the focus tree at the Next_Level of the hoParent in the focus tree
BellProcedureRings the PC bell
CancelProcedureUsed to terminate the current level of a start_ui or ui_accept
CanCopyFunctionDetermines whether a Copy operation can be successfully completed
CanCutFunctionDetermines whether a Cut operation can be successfully completed
CanDeleteFunctionDetermines whether a Delete operation can be successfully completed
CanPasteFunctionDetermines whether a Paste operation can be successfully completed
CanSelectFunctionDetermines whether a Select operation can be successfully completed
CanUndoFunctionDetermines whether n Undooperation can be successfully completed
ConfirmFunctionPops up a "Yes/No" confirmation
Data_Loss_ConfirmationFunctionPops up a "Yes/No" confirmation for data loss
DeactivateProcedureRemoves the object from the focus tree
Default_KeyProcedureUsed in On_key command to restore standard accelerator for an object
Delete_ConfirmationFunctionPops up a "Yes/No" confirmation for a delete
Exit_Loss_ConfirmationFunctionPops up a "Yes/No" confirmation for exit loss
ItemProcedure SetChanges the current item to the first or last data item (depending on the value of last) in the displayed range of items
Line_Delete_ConfirmationFunctionPops up a "Yes/No" confirmation for a line delete
Line_Save_ConfirmationFunctionPops up a "Yes/No" confirmation for a line save
NextProcedureMoves the focus to the next object in the tab order when the Tab key is pressed
No_ConfirmationFunctionUsed to cancel a confirmation message
NoneProcedureDoes nothing - used by on_key and commands to stop a key assignment
OkProcedureUsed on items and accelerator key definitions to terminate the current level of start_ui or ui_accept
PopupProcedureActivates a modal dialog
PreviousProcedureMoves the focus to the previous object in the tab order when the Shift+Tab key is pressed
Save_ConfirmationFunctionPops up a "Yes/No" confirmation for a save
Stop_UIProcedureTerminates a popup_modal message and returns execution to the next line after the one on which this message was sent
SwitchProcedureMoves the focus to the object returned by the next_object_id function
Switch_BackProcedureMoves the focus to the object returned by the prior_object_id function
Switch_Next_GroupProcedureMoves the focus to the first object in the next_level of the next_object of the prior_level of this object
Switch_Next_ScopeProcedureMoves the focus to the scope focus of the next scope
Switch_Prior_GroupProcedureMoves the focus to the last object in the prior_level of the prior_object of the next_level of this object
Switch_Prior_ScopeProcedureMoves the focus to the scope focus of the prior_scope

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
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]