Methods for cBaseLocalControlHost
View method list in alphabetical order.
| 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. | cBaseLocalControlHost |
| AddResponseAttachment | Function | Adds an attachment to the response Adds an attachment to the response and returns the integer id of the attachment. | cBaseLocalControlHost |
| AppSynching | Function | Returns True if the application is in an initializing state Returns True if the application is in an initializing state. | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| 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). | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| ClientTranslations | Function | Returns translations in an array of name value structs Returns translations in an array of name value structs. | cBaseLocalControlHost |
| ConditionalFocus | Procedure | Gives the control the focus but only if the browser platform is not a mobile device (tablet / phone) | cBaseLocalControlHost |
| Define_cWebRadioContainer_mixin | Procedure | cBaseLocalControlHost | |
| 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). | cBaseLocalControlHost |
| 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 | cBaseLocalControlHost |
| 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 | cBaseLocalControlHost |
| FindWebObject | Function | cBaseLocalControlHost | |
| FindWebObjectSilent | Function | cBaseLocalControlHost | |
| Focus | Procedure | Gives the control the focus Gives the control the focus. | cBaseLocalControlHost |
| FocusObject | Function | Returns the object handle of the object representing the currently focused control on the client | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| HistoryPushState | Procedure | Pushes a new history item to the history stack Pushes a new history item to the history stack. | cBaseLocalControlHost |
| 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). | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| InitDynamicProp | Procedure | Sets a dynamic property value Sets a dynamic property value. | cBaseLocalControlHost |
| Initializing | Function | Determines whether the WebApp host (cWebApp or cLocalWebAppHost) is still initializing (objects are being created and initialized) | cBaseLocalControlHost |
| IsDynamicObject | Function | Checks whether the object is dynamic or not Checks whether the object is dynamic or not. | cBaseLocalControlHost |
| IsLoaded | Function | Checks if the webobject is loaded to the client | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| NavigateNewWindow | Procedure | Opens a URL in a new browser window with specified height and width. | cBaseLocalControlHost |
| NavigatePath | Procedure | Performs the navigation registered for this web object Performs the navigation registered for this web object. | cBaseLocalControlHost |
| NavigateRefresh | Procedure | Reloads web application in the browser Send NavigateRefresh to reload your web application in the browser. | cBaseLocalControlHost |
| NavigateToPage | Procedure | Opens a URL in a new browser tab, a new browser window or replaces your web application | cBaseLocalControlHost |
| ptActionData | Function | Retrieves the action data for a server action as value tree Retrieves the action data for a server action as value tree. | cBaseLocalControlHost |
| RegisterOnCallEndEvent | Procedure | cBaseLocalControlHost | |
| RemoveKeyHandler | Procedure | Removes a client side key handler It is possible to assign custom key handlers to controls and containers. | cBaseLocalControlHost |
| RemoveOnCallEndEvent | Procedure | cBaseLocalControlHost | |
| RequestAttachment | Function | Retrieves an attachment from the request based on its index Retrieves an attachment from the request based on its index. | cBaseLocalControlHost |
| ResourceManager | Function | Returns handle to the cWebResourceManager object Use this function to get a handle to the cWebResourceManager object. | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| ServerPropStore | Function | Returns handle to the cWebServerPropStore object Use this function to get a handle to the cWebServerPropStore object. | cBaseLocalControlHost |
| ServiceDispatcher | Function | Returns handle to the cWebServiceDispatcher object Use this function to get a handle to the cWebServiceDispatcher object. | cBaseLocalControlHost |
| SessionManager | Function | Returns handle to the cWebSessionManager object Use this function get a handle to the cWebSessionManager object. | cBaseLocalControlHost |
| SetActionMode | Procedure | Allows developer to configure a wait dialog for every server action | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| ShowMessageBox | Procedure | Displays a web message box ShowMessageBox can display a great variety of custom web message boxes. | cBaseLocalControlHost |
| ShowYesNo | Procedure | Displays an information dialog with Yes and No buttons The ShowYesNo message is used to handle yes/no confirmations. | cBaseLocalControlHost |
| ShowYesNoCancel | Procedure | Displays an information dialog with Yes, No and Cancel buttons The ShowYesNoCancel message is used to handle yes/no/cancel confirmations. | cBaseLocalControlHost |
| UnSyncWebProperty | Procedure | Unsynchronizes a client web property Unsynchronizes a client web property. | cBaseLocalControlHost |
| UploadFolder | Function | Determines the path to the default upload folder Returns the full file path of the standard Upload folder of the current workspace. | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| ViewStack | Function | Returns handle to the cWebViewStack object Use this function to get a handle to the cWebViewStack object used in drill-down applications. | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| WebMethodName | Function | Converts the message handle of a web method into a string Converts the message handle of a web method into a string. | cBaseLocalControlHost |
| 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. | cBaseLocalControlHost |
| WebObjectName | Function | The public web object name of this object Returns the public web object name of this object. | cBaseLocalControlHost |
Inherited Methods from cWebView2Browser
| Name | Type | Description | Defining Class |
|---|---|---|---|
| AddScriptToExecuteOnDocumentCreated | Function | Adds a script that will be executed during the loading of the future documents Adds a script that will be executed during the loading of the future documents. | cWebView2Browser |
| AddWebResourceRequestedFilter | Procedure | Sets up a resource request filter that will enable the OnWebResourceRequested for these requests | cWebView2Browser |
| CapturePreview | Procedure | Captures the currently displayed document into an image Captures the currently displayed document into an image. | cWebView2Browser |
| ClearVirtualHostNameToFolderMapping | Procedure | Clears a virtual hostname mapping created using SetVirtualHostNameToFolderMapping | cWebView2Browser |
| ExecuteScript | Function | Executes a script within the current top-level document of the WebView2 control Executes a script within the current top-level document of the WebView2 control. | cWebView2Browser |
| GoBack | Procedure | Navigates one step back in the browser history Navigates one step back in the browser history. | cWebView2Browser |
| GoForward | Procedure | Navigates one step forward in the browser history Navigates one step forward in the browser history. | cWebView2Browser |
| Navigate | Procedure | Initiates a browser navigation to the provided URL Initiates a browser navigation to the provided URL. | cWebView2Browser |
| NavigateToString | Procedure | Renders the provided HTML as top-level document Renders the provided HTML as top-level document. | cWebView2Browser |
| OpenDevToolsWindow | Procedure | Opens the developer tools window Opens the developer tools window. | cWebView2Browser |
| PostWebMessageAsJson | Procedure | Posts a message to the document loaded inside the WebView2 control Posts a message to the document loaded inside the WebView2 control. | cWebView2Browser |
| PostWebMessageAsJsonHandle | Procedure | Posts a message to the document loaded inside the WebView2 control Posts a message to the document loaded inside the WebView2 control. | cWebView2Browser |
| PostWebMessageAsString | Procedure | Posts a message to the document loaded inside the WebView2 control Posts a message to the document loaded inside the WebView2 control. | cWebView2Browser |
| Reload | Procedure | Reloads the current document Reloads the current document. | cWebView2Browser |
| RemoveScriptToExecuteOnDocumentCreated | Procedure | Removes a script that is added using AddScriptToExecuteOnDocumentCreated | cWebView2Browser |
| RemoveWebResourceRequestedFilter | Procedure | Removes a resource request filter that was previously set up using AddWebResourceRequestedFilter | cWebView2Browser |
| SetVirtualHostNameToFolderMapping | Procedure | Creates a virtual mapping between the provided host name and a local folder on disk Creates a virtual mapping between the provided host name and a local folder on disk. | cWebView2Browser |
| Stop | Procedure | Stops all navigations and pending resource fetches Stops all navigations and pending resource fetches. | cWebView2Browser |
| WebMessageAdditionalFileObjectPaths | Function | Can be used to query file paths of additional file objects passed with a WebMessage | cWebView2Browser |
| WebResourceRequestContent | Function | Use this function inside OnWebResourceRequested to query the HTTP request body of the current resource request | cWebView2Browser |
| WebResourceRequestHeader | Function | Use this function inside OnWebResourceRequested to query a specific HTTP header value of the current resource request | cWebView2Browser |
| WebResourceResponseSet | Procedure | Can be used inside OnWebResourceRequested to set additional header values for the response. | cWebView2Browser |
| WebResourceResponseSetHeader | Procedure | Use inside OnWebResourceRequested to set additional HTTP headers on the response when overriding the response using WebResourceResponseSet | cWebView2Browser |
Inherited Methods from cComActiveXControl
| Name | Type | Description | Defining Class |
|---|---|---|---|
| IsComObjectCreated | Function | Tests to see if a COM object exists by getting the value of IsComObjectCreated You can test to see if a COM object exists by getting the value of IsComObjectCreated. | cComActiveXControl |
| Request_Status_Help | Procedure | Sent when an object is about to take or lose the focus The Request_Status_Help message is sent when an object is about to take or lose the focus. | cComActiveXControl |
| Switch_Next_Area | Procedure | Moves the focus to the next "area" within a view The Switch_Next_Area navigation message moves the focus to the next "area" within a view. | cComActiveXControl |
| Switch_Prior_Area | Procedure | Moves the focus to the previous "area" within a view The Switch_Prior_Area navigation message moves the focus to the previous "area" within a view. | cComActiveXControl |
Inherited Methods from DfInPlaceComObject
| Name | Type | Description | Defining Class |
|---|---|---|---|
| ComAddRef | Procedure | DfInPlaceComObject | |
| ComQueryInterface | Function | DfInPlaceComObject | |
| CreateComObject | Procedure | Sent to create and connect to an instance of the ActiveX control associated with this object | DfInPlaceComObject |
| RegisterComEvent | Procedure | DfInPlaceComObject | |
| RegisterPropertyChangeEvent | Procedure | DfInPlaceComObject | |
| ReleaseComObject | Procedure | Releases ActiveX control associated with this object ReleaseComObject is sent to release ActiveX control associated with this object. | DfInPlaceComObject |
Inherited Methods from DfComUIObject
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Adjust_Logicals | Procedure | Sets the logical coordinates for size and location to the best approximations of the actual physical coordinates of the object | DfComUIObject |
| DialogToGui | Function | This is used to convert dialog units to gui units. | DfComUIObject |
| GuiClientSize | Function | This returns an object's client area size as a folded integer value This returns an object's client area size as a folded value. | DfComUIObject |
| GuiToDialog | Function | This is used to convert gui units to dialog units. | DfComUIObject |
| GuiWindowSize | Function | This returns an object's outer window bounding size as a folded value This returns an object's window bounding size as a folded value. | DfComUIObject |
| Release_Mouse_Capture | Procedure | Restores normal mouse capture | DfComUIObject |
Inherited Methods from cUIObject
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Activate | Procedure | Gives an object the focus (and adds it to the focus tree) | cUIObject |
| Activate_Scope | Procedure | Activates objects that are separate tools to the application The Activate_scope message is used to activate objects that are separate tools to the application. | cUIObject |
| Add_Focus | Procedure | Adds the object into the focus tree at the Next_Level of the hoParent in the focus tree | cUIObject |
| Bell | Procedure | Rings the PC bell | cUIObject |
| Cancel | Procedure | Used to terminate the current level of a start_ui or ui_accept This message is used to terminate the current level of a start_ui or ui_accept with a return value of msg_cancel. | cUIObject |
| CanCopy | Function | Determines whether a Copy operation can be successfully completed Determines whether a Copy operation can be successfully completed. | cUIObject |
| CanCut | Function | Determines whether a Cut operation can be successfully completed Determines whether a Cut operation can be successfully completed. | cUIObject |
| CanDelete | Function | Determines whether a Delete operation can be successfully completed Determines whether a Delete operation can be successfully completed. | cUIObject |
| CanPaste | Function | Determines whether a Paste operation can be successfully completed Determines whether a Paste operation can be successfully completed. | cUIObject |
| CanSelect | Function | Determines whether a Select operation can be successfully completed Determines whether a Select operation can be successfully completed. | cUIObject |
| CanUndo | Function | Determines whether n Undooperation can be successfully completed Determines whether an Undo operation can be successfully completed. | cUIObject |
| Confirm | Function | Pops up a "Yes/No" confirmation The Confirm function can be used to pop up a "Yes/No" confirmation. | cUIObject |
| Data_Loss_Confirmation | Function | Pops up a "Yes/No" confirmation for data loss | cUIObject |
| Deactivate | Procedure | Removes the object from the focus tree The Deactivate message removes the object from the focus tree and, if successful, sends the Deactivating message. | cUIObject |
| Default_Key | Procedure | Used in On_key command to restore standard accelerator for an object The Default_Key message is only used as part of the On_Key command. | cUIObject |
| Delete_Confirmation | Function | Pops up a "Yes/No" confirmation for a delete | cUIObject |
| Exit_Loss_Confirmation | Function | Pops up a "Yes/No" confirmation for exit loss Prompts: Changes Exist. | cUIObject |
| Help | Procedure | Overridden in the help_system to activate context-sensitive help By default, this message does nothing. | cUIObject |
| Item | Procedure Set | cUIObject | |
| Line_Delete_Confirmation | Function | Pops up a "Yes/No" confirmation for a line delete | cUIObject |
| Line_Save_Confirmation | Function | Pops up a "Yes/No" confirmation for a line save | cUIObject |
| Next | Procedure | Moves the focus to the next object in the tab order when the Tab key is pressed Next moves the focus to the next object in the tab order when the Tab key is pressed. | cUIObject |
| Next_Object_Id | Function | Called by the switch message to determine the object_id of the next object to go to in the focus tree | cUIObject |
| No_Confirmation | Function | Used to cancel a confirmation message The No_Confirmation function is used to cancel a confirmation message. | cUIObject |
| None | Procedure | Does nothing - used by on_key and commands to stop a key assignment This message is always used to make a on_key assignment or an add_item message do nothing. | cUIObject |
| Ok | Procedure | Used on items and accelerator key definitions to terminate the current level of start_ui or ui_accept | cUIObject |
| Page_Object | Procedure | Adds or removes an object from the focus tree Adds or removes an object from the focus tree. | cUIObject |
| Popup | Procedure | Activates a modal dialog Popup activates a modal dialog. | cUIObject |
| Previous | Procedure | Moves the focus to the previous object in the tab order when the Shift+Tab key is pressed Previous moves the focus to the previous object in the tab order when the Shift+Tab key is pressed. | cUIObject |
| Prior_Object_Id | Function | Called by the switch_back message to determine the object_id of the previous object to go to in the focus tree | cUIObject |
| Save_Confirmation | Function | Pops up a "Yes/No" confirmation for a save The Save_Confirmation function pops up a "Yes/No" confirmation for a save. | cUIObject |
| Stop_UI | Procedure | Terminates a popup_modal message and returns execution to the next line after the one on which this message was sent | cUIObject |
| Switch | Procedure | Moves the focus to the object returned by the next_object_id function | cUIObject |
| Switch_Back | Procedure | Moves the focus to the object returned by the prior_object_id function | cUIObject |
| Switch_Next_Group | Procedure | Moves the focus to the first object in the next_level of the next_object of the prior_level of this object | cUIObject |
| Switch_Next_Scope | Procedure | Moves the focus to the scope focus of the next scope The Switch_Next_Scope message moves the focus to the scope focus of the next scope. | cUIObject |
| Switch_Prior_Group | Procedure | Moves the focus to the last object in the prior_level of the prior_object of the next_level of this object | cUIObject |
| Switch_Prior_Scope | Procedure | Moves the focus to the scope focus of the prior_scope The Switch_Prior_Scope message moves the focus to the scope focus of the prior_scope. | cUIObject |
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 |