Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


false
Info

Built with v10.

This example demonstrates how to use the HTML5Control component

icon

Download the Solution Example here: ControlHTML5.dbsln

Download the CSS and JS scripts here: Control.css Control.js

  • Solution Name: ControlHTML5
  • Software Version: v10
  • Keywords: HTML5. CSS. JavaScript.



    Summary

    This example demonstrates how to use the HTML5Control component, which allows applying any CSS or JS scripts on any HTML5 display of your solutions.


    Technical Information

    The example demonstrates how to use the HTML5 control to execute embedded CSS and JS scripts, enhancing the display with custom styles and interactive functionalities.

    Step-by-Step:

    1. First, in FrameworX, we need to set up the path to the references that will be used in the HTML5 control.

    This can be arranged by opening a new communication port using the command httpserver -p 8000, which starts a simple HTTP server on the specified port (8000 in this case) if you have local files.

    Alternatively, you can use the HTML5 folder inside FrameworX’s directory at C:\Program Files (x86)\Tatsoft\FrameworX\HTML5 and access the files through our web server at the following URLs:

    Next, in the FrameworX code behind, we need to initialize the HTML5_Control component. To do this, we first retrieve its "uid":

    In this case, the "Control" refers to the component.

    Now that this is established, we need to use the function this.OnInitializeControl = function(control) in JavaScript to initialize the control. This function will pass the control to every object on the screen, allowing you to verify if it’s the correct one by comparing the "uid" as shown below:

    Code Block
    languagec#
    titleHTML5 Control
    if (control.Uid == "Control") {
        // Find the exact object by its uid
        // Do something;
    }


    From here, we typically call another function that we will create to initialize the HTML5 object directly. However, to understand this process better, let's take a look inside the JS script:

    In this step, we created a function called InitializeObject that receives the "uid" as a parameter. All we need to do now is call this function in FrameworX to create the objects we want and apply the functionalities from the JS code to them.

    In FrameworX code behind (JavaScript HTML5 Display), we can set up the following code:

    Code Block
    languagejs
    titleJS
    this.OnInitializeControl = function(control) {
        console.log(control);
    
        if (control.Uid == "Control") { // Find the exact object by its uid
            this.startObject(control.id); // Start the JS object for that specific control.id
        }
    };
    
    this.startObject = function(uid) {
        InitializeObject(uid); // Initialize the object using the "InitializeObject" function from <object>.js
    };

    This process initializes the object in FrameworX and makes it accessible in the HTML5 Displays. This is possible because we created this Object (CSS and JS).



    Reference Information

    → See HTML5 Controls for more information.


    In this section:

    Page Tree
    root@parent
    spacesV10