mobileFX WebKitX CEF3 ActiveX 4.x
WebKitXCEF3Lib ActiveX Control / WebKitXCEF3 Object
Overview
In This Topic
    WebKitXCEF3 Object Members
    In This Topic
    Public Methods

    Registered a Commercial License to the control. Commercial License validation is performed off-line at run-time.

    Registered a Terminal License to the control. Terminal License validation is performed on-line at run-time.

    Registered a Workstation activation key to the control. Workstation validation is performed off-line at design-time.

    Adds code to the global JavaScript object of the currently loaded page.

    Binds a native event handler to an HTML5 event. This is the AddressOf method.

    Binds a native event handler to an HTML5 event. This is the IDispatch method.

    Exports a native COM object to JavaScript.

    Add a new <SCRIPT> element in the currently loaded page and set its URL.

    Calls a JavaScript function synchronously of the global scope and returns its result.

    Calls a JavaScript function asynchronously of the global scope, no result is returned.

    Cancels downloading of a resource that started with Download method.

    Captures the screenshot of an HTML element. Requires Settings.remote_debugging_port to be set.

    Resets navigation performance counters, use this method before loading a page.

    Clears the HTML5 Editor Undo Buffer.

    Closes Chrome Developer Tools.

    Commits HTML5 to Undo buffer.

    Copy WebKitX screenshot to clipboard.

    Creates CEF Browser explicitly.

    Reserved.

    Adds a Break point to a Debugger. 

     

    Resumes JavaScript execution on a Debugger.

    Disables the Debug domain.

    Enables the Debug domain.

    Evaluates an expression against a Call Frame of a paused Debugger and returns its JSON representation.

    Returns properties of a given object. Object group of the result is inherited from the target object.

    Returns source for the script with given id or URL.

    Stops on the next JavaScript statement.

    Removes JavaScript breakpoint.

     

    Edits JavaScript source live.

    Steps into the function call.

    Steps out of the function call.

    Steps over the statement.

    Delete an HTML5 Element by CSS3 Selector.

    Delete cookies.

    Collapses current selection and fires the OnDeselect event.

    Causes the CEF processes to terminate and the browser to be destroyed.

    Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order.

    Dispatches an Event asynchronously at the specified EventTarget, invoking the affected EventListeners in the appropriate order.

    Downloads a File.

    Enables HTML5 Editor.

    Enables support for High DPI monitors in host application's current process.

    Evaluates JavaScript code and returns a String result.

    Execute commands that manipulate the current editable region.

    Execute a DevTools Command.

    Flush the backing store (if any) to disk.

    Returns an attribute value of an HTML5 Element.

    Returns a space-separated string list of attribute=value pairs of all element attributes by selector.

    Returns all cookies.

    Return the declared style or the computed style of an HTML5 Element.

    Return the inner HTML of an HTML5 Element.

    Get INPUT element value directly.

    Resolves the CSS3 stylesheets that compose the end-style of an HTML5 element.

    Converts a CSS3 selector into Inspector Protocol NodeID.

    Return the outer HTML of an HTML5 Element.

    Obtains the Navigation Performance Counters of the current page. The method is used during QA to examine loading times of a page's resources.

    Return the value of a CEF Browser preference.

    Get selection Offset and Length in HTML buffer.

    Returns a setting value from style.cssText of an HTML5 Element.

    Hides the inspector rectangle.

    Utility function for performing synchronous HTTP Requests.

    Draws an inspector rectangle around the bounds of an HTML5 element.

    Calls a JavaScript function of a specific scope.

    Converts a JSON string to an XML representation.

    Load the previous URL of the main frame of the Browser.

    Load the next URL of the main frame of the Browser. 

    Opens a URL for loading.

    Performs a controlled HTTP request to a web service, typically used for OAuth requests.

    Opens a Disk Web file for Browsing or Editing.

    Pause an HTTP Live Stream Video.

    Play HTTP Live Stream Video by URL.

    Disables HTML5 Editor.

    Print current document to default printer.

    Prints a PDF by filename to a printer by printername.

    Creates and returns a volatile Just-In-Time (JIT) COM Wrapper / Proxy for an HTML5 Element, or Document, or Window objects.

    This feature is designed to allow basic read / write DOM manipulation without resolving to JavaScript execution.

    Creates and returns a variant array (VT_ARRAY | VT_DISPATCH) of volatile Just-In-Time (JIT) COM Wrappers / Proxies of HTML5 Element. This feature is designed to allow basic read / write DOM manipulation without resolving to JavaScript execution.

    Read dictionary-based data from local storage.

    Performs a Redo operation.

    Releases the Proxy and Stub objects created by AddObject and releases the COM object.

    Reloads current page. Optionally can reload current page by ignoring cache.

    Removes an attribute from an HTML5 Element.

    Removes an event listener previously set by AddEventListener.

    Removes an event listener previously set by AddEventListenerEx.

    Signals CEF Browser to repaint asynchronously.

    Replaces text in DOM nodes.

    Saves HTML5 to a local file.

    Prints HTML5 to a local PDF file.

    Saves WebKitX screenshot as image file.

    Alias for ExecCommand(EDIT_CMD_SEL_ALL_CHILDREN)

    Alias for ExecCommand(EDIT_CMD_SEL_COLLAPSE_TO_END)

    Alias for ExecCommand(EDIT_CMD_SEL_COLLAPSE_TO_START)

    Alias for ExecCommand(EDIT_CMD_SEL_GET_CONTAINS_NODE)

    Alias for ExecCommand(EDIT_CMD_SEL_DELETE)

    Selects the contents of an HTML5 Element.

    Selects an entire Table Column. 

    Alias for ExecCommand(EDIT_CMD_SEL_EMPTY)

    Alias for ExecCommand(EDIT_CMD_SEL_EXTEND)

    Sets an attribute value of an HTML5 Element.

    Sets a space-separated string list of attribute=value pairs to an HTML5 Element.

    Enables or disables automatic CEF Browser resizing when ActiveX surface resizes.

    Sets a cookie given a valid URL and explicit user-provided cookie attributes.

    Sets the style.cssText property of an HTML5 Element.

    Populates an IDataObject object with HTML content.

    Must be called from inside OnBeforeDownload event handler to provide Path and FileName to the event.

    This is a helper function for programming languages that do not support ByRef arguments.

    Set the inner HTML of an HTML5 Element.

    Set INPUT element value directly.

    Sets an MDI window handle to monitor for size and position changes in order to repaint child windows that host WebKitX browsers.

    Set the outer HTML of an HTML5 Element.

    Set the value of a CEF Browser preference.

    Selects an HTML5 range in CEF Browser given the Offset and Length of a sub-string of the raw HTML buffer.

    Appends a style setting and value to style.cssText of an HTML5 Element.

    Shows Chrome Developer Tools and optionally inspects an HTML element.

    Runs a JavaScript program with node.js executive.

    Signal browser to stop loading current URL.

    Stops the node.js child process.

    Returns the formatted HTML5 input buffer.

    Performs an Undo operation.

    Write dictionary-based data to local storage.

    Public Properties

    Returns the CSS3 Selector of the Active HTML5 Element.

    This master flag controls if HTML5 DOM Events that you setup by Events property should be synchronous or asynchronous.

    Sets or retrieves the Base URL of the Main Frame.

    Read Only - This flag is set to True before the OnBrowserReady event is fired.

    Returns True if the Redo Buffer is not empty.

    Returns True if the Undo Buffer is not empty.

    Set Chromium Embedded Framework command line switches.

    Returns the URL for the main Frame in the Browser.

    Reserved

    Reserved

    Reserved

    When set to True (default) delays browser sub-processes creation until the first paint of the control.

    Returns a hash of unique values of the Developer Workstation.

    When set to True it delays GDI+ initialization.

    Return an HTML5Document wrapper / proxy for Document Element.

    This master flag enables or disables JavaScript.

    To use WebKitX in HMI environments you must set Enable_HMI_IO to True.

    Used to setup a generic event handler that provides fast event handling for various events.

    This master flag enables or disables setting focus to the control after ExecCommand is executed.
    Enables or disables firing OnEvent for HTML5 DOM Events when attaching to them with AddEventListener and AddEventListenerEx.
    Enables or disables formatting using internal Selection API commands vs. Chromium Commands.

    Returns true if a valid commercial license is provided.

    Returns true is a valid Terminal License is provided.

    Returns true is a valid Workstation License is provided.

    When set, the control creates the browser and loads the URL defined.

    The property is intended to be used by Rockwell FactoryTalk.

    To use WebKitX in HMI environments you must set Enable_HMI_IO to True.

    HMI_VALUE_xxx properties are bi-directional I/O channels intended for passing sensor data directly to HTML/JavaScript for HMI/HUD displays, or for forwarding control signals from HTML to the underlying Automation or IoT controller software. The property is intended to be used by Rockwell FactoryTalk. To use WebKitX in HMI environments you must set Enable_HMI_IO to True.

    Sets or retrieves the HTML markup of the main Frame.

    Returns the HTTP Status of the main frame.

    Returns the Window Handle of the ActiveX Control.

    Returns the Window Handle of Chromium Browser Control.

    Reserved
     

    Sets or retrieves the Modified state of the HTML5 page being edited.

    Read Only - This flag is set to True before the OnPageComplete event is fired.

    Returns the size in actions of the Redo buffer.

    Returns true is a Terminal License is required.

    Returns the CSS3 selector of the Selection.anchorNode property, which is the HTML5 DOM Node in which the selection begins.

    Executes ExecCommand(EDIT_CMD_SEL_GET_COLLAPSED) and returns True if successful.

    Returns the CSS3 selector of the Selection.focusNode property, which is the HTML5 DOM Node in which the selection ends.

    Sets or retrieves the Background Font Color of the current selection.

    Sets or retrieves if the current selection is Bold.

    Sets or retrieves the Font Color of the current selection.

    Sets or retrieves if the current selection is Italic.

    Sets or retrieves the Font Name of the current selection.

    Sets or retrieves the Font Size of the current selection.

    Sets or retrieves if the current selection is Underline.

    Sets or retrieves the HTML markup of the current selection.

    Sets or retrieves if the current selection is Stroked. 

    Sets or retrieves the Text of the current selection.

     Retrieves the Type of the current selection.

    Enables or disables Spell Checking during HTML5 Editing.

    Simulates Internet Explorer window.statusText

    This master flag enables Undo / Redo API during HTML5 Editing.

    This master flag enables Undo / Redo observer.

    Returns the size in actions of the Undo buffer.

    Sets or retrieves the URL of the Main Frame.

    Return an HTML5Window wrapper / proxy for window Element.

    Retrieves the XHTML markup of the <BODY> Element using a custom implementation of XMLSerializer object.

    Sets or retrieves the scale factor of the HTML rendering window. Default is 1.0.

    Events

    Fired when a frame's address has changed.

    Fired after ExceCommand works are done.

    Fired before a resource download starts. Resource download is initiated by Download method.

    Fires before ExecCommand works begin.

    Fired before a Frame loads a new URL. The event is classified as synchronous and for performance reasons is disabled by default. Read remarks section below to enable it.

    Fired when the Chromium Embedded Browser has been created and it is ready to start loading URLs and HTML. Handle this event to enable JavaScript and Open your URL (or load plain HTML)

    Fired when you execute in JavaScript the window.postComMessage(value) function in order to pass values from JavaScript to your application.

    Fired when you execute in JavaScript the console.log function.

    Fired when user right-clicks on a Frame window of the Browser.

    Fired before the Chromium Embedded Browser sub-processes are created.

    Fired when a Break point is hit or an exception is raised in JavaScript code of either Chromium or Node.js.

    Fired when code execution is paused either Chromium or Node.js.

    Fired when code execution is resumed either Chromium or Node.js.

    Fired when a Script is parsed either Chromium or Node.js.

    Fired when Debugger has started either Chromium or Node.js.

    Fired when Debugger has terminated either Chromium or Node.js.

    Fired when a selection in HTML5 DOM collapses (when you de-select).

    Fired when a Chromium Inspector Protocol Event is generated or as a result of an Inspector Protocol command.

    Fired while a resource is being downloaded. Resource download is initiated by Download method.

    Set various HTML formats to an OLE Drag-and-Drop or Clipboard IDataObject instance.

    Fired when a generic error Win32 error has occurred, intended for integration debugging purposes during development. This does not fire HTML errors.

    Fired when an HTML5 DOM Event occurs. This is generic event handler that provides fast event handling for various events.

    Fired when browser toggles Full Screen mode.

    Fired when HMI_VALUE property is changed. 

    Fired when ActiveX to CEF3 Process Inter-process Communication (IPC) times-out.

    Notification that a character was typed. The event fires before the HTML renderer processes it.

     Notification that a key was pressed. The event fires before the HTML renderer processes it.

    Notification that a key transitioned from up to down. The event fires before the HTML renderer processes it.

    Notification that a key was released. The event fires before the HTML renderer processes it.

    Fired when the browser is done loading a frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. 

    Fired when a Frame has failed to load its contents. You receive this event for every browser frame in the HTML (main window and IFRAMEs).

    Fired when the loading state has changed.

    Fired after a navigation has been committed and before the browser begins loading contents in the frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended.

    Fired when all Frames of the Browser have loaded, parsed and rendered.

    OnPageComplete is implemented with a 3-seconds loop that polls all frames of the page for document.readyState = 'complete'. If all frames respond that are 'complete' then OnPageComplete fires; otherwise it re-tries in 3-seconds.

    Fired after OnLoadEnd fires for a Frame, providing information about the Frame.

    Fired after OnLoadStart fires for a Frame, providing information about the Frame.

    Fired when a protocol link is clicked. Used with Settings.fire_protocol_event.

    Fired after a Redo operation is executed.
     
    Fired when a Script Resource is cancelled. To control scripts download set DownloadScripts to False.

    Fired when the browser receives a status message.

    Fired when browser <TITLE> element of a Frame's HTML5 has been parsed.

    Fired when the browser is about to display a tooltip.

    Fired after a Undo operation is executed.
    Fired after a Commit operation is executed.

    Fired when WebKitX Debugger WebSocket is closed.

    Fired when WebKitX Debugger WebSocket receives an Error.

    Fired when WebKitX Debugger WebSocket is connected to Chromium or Node.js debug server.

    Simulates Internet Explorer window.statusText and fires when status text changes.

    See Also