User Tools

Site Tools


Sidebar

en:objects:interface:action:screenshot

screenshot

screenshot($file_path,$as_gray=false); - save a screenshot of the element via the DOM model to disk

The function accepts parameters as input:

  • $file_path – path to the file where the screenshot of the element will be saved. By default, the screenshot format is jpeg. The following screenshot file formats are also supported (set by the file extension): bmp,gif,png. The path to the file can be full (with the disk specified) so the relative path will be added to the folder where the php file of the running script is located.
  • $as_gray – specifies to take a screenshot in gray (true), available from version 7.0.6

    After testing, the function returns the result of its work to the script (the return value type is boolean):
  • true – completed successfully
  • false – it was not possible to find such an element (for example, there are no elements that meet the specified criteria or there is no such frame)

    PHP example:

    <?php $xhe_host = "127.0.0.1:7014";
     
    //connect the object to control the emulator, if not already connected
    if(!isset($path))
      $path = "../../../Templates/xweb_human_emulator.php";
    require($path);
     
    //Start
    echo "<hr> <font color = blue> interface->".basename(__FILE__)."</font> <hr>";
     
    $browser->navigate("ya.ru")."<br>";
    $app->minimize_to_tray();
     
    //1
    echo "1.Let's go to the polygon:";
    echo $browser->navigate("http://humanemulator.net/poligon/image.html")."<br>";
     
    //2
    echo "2.Save a picture by its name to a file:";
    echo $image->get_by_name("captcha1")->screenshot("c:\sc.jpg")."<br>";
    //show what is preserved
    $app->shell_execute("open", "c:\sc.jpg");
     
    //3
    echo "3.Save the picture by its name to a file and display the size of the picture in the browser:";
    $obj = $image->get_by_name("screen2");
    $obj->focus();
    echo $obj->screenshot("c:\sc2.jpg")."".$obj->get_width()."".$obj->get_height()."<br>";
    //show what is preserved
    $app->shell_execute("open", "c:\sc2.jpg");
     
    echo "4.Save drawing(simplified) by its name to file:";
    echo $image->get_by_name("screen1", 0)->screenshot("c:\sc2.jpg", true)."<br>";
    //show what is preserved
    $app->shell_execute("open", "c:\sc2.jpg");
     
    //screenshot with scrolling of children
    $browser->navigate('https://signup.live.com/signup');
    $image->get_by_number(6)->scroll_to_view(0);
    $image->get_by_number(6)->screenshot("c:\screenshot.jpg");
    $app->shell_execute("open", "c:\screenshot.jpg");
     
    $app->show_from_tray();
     
    //end
    echo "<hr><br>";
     
    //Quit
    $app->quit();
    ?>

    Python example:

    # Additional paths
    import sys
    sys.path.insert(0, '../../../Templates PY/')
     
    xhe_host = "127.0.0.1:7018"
    from xweb_human_emulator import *
     
    # Start
    echo("<hr> <font color = blue> interface.xxxxxxxxx </font> <hr>")
     
    # 1
    echo("1.Let's go to the polygon:")
    echo(browser.navigate("http://www.humanemulator.net/poligon/image.html"), "<br>")
     
    # 2
    echo("2.Save the picture by its name to a file:")
    echo(image.get_by_name("captcha1").screenshot("c:\sc.jpg"), "<br>")
    # show what has survived
    app.shell_execute("open", "c:\sc.jpg")
     
    # 3
    echo("3.Save the picture by its name to a file and display the size of the picture in the browser:")
    obj = image.get_by_name("chek_obrazec")
    echo(obj.screenshot("c:\sc2.jpg"), "")
    echo(obj.get_width(), "")
    echo(obj.get_height(), "<br>")
    # show what has survived
    app.shell_execute("open", "c:\sc2.jpg")
     
    # 4
    echo("4.Save the image(simplified) by its name to a file:")
    echo(image.get_by_name("captcha1").screenshot("c:\sc2.jpg", True), "<br>")
    # show what has survived
    app.shell_execute("open", "c:\sc2.jpg")
     
    # end
    echo("<hr><br>")
     
    # Quit
    app.quit()

    C# example:

    #region using
     
    using System;
    using System.Diagnostics;
    using System.Collections.Generic;
    using System.Linq;
    using System.IO;
    using System.Text;
    using System.Threading;
     
    using XHE;
    using XHE.XHE_DOM;
    using XHE.XHE_System;
    using XHE.XHE_Window;
    using XHE.XHE_Web;
     
    #endregion
     
     class Program: XHEScript
     {
    static void Main(string [] args)
    {
    //init XHE
    server = "127.0.0.1:7018";
    InitXHE();
     
    //Start
    echo("<hr> <font color = blue> interface.screenshot </font> <hr>");
     
    //1 step
    echo("1.Let's go to the polygon:");
    echo(browser.navigate("www.humanemulator.net/poligon/image.html") + "<br>");
     
    //step 2
    echo("2.Save the picture by its name to a file:");
    echo(image.get_by_name("captcha1").screenshot("c:\sc.jpg") + "<br>");
    //show what is preserved
    app.shell_execute("open", "c:\sc.jpg");
     
    //step 3
    echo("3.Save the picture by its name to a file and display the size of the picture in the browser:");
    XHEInterface obj = image.get_by_name("screen2");
    echo(obj.screenshot("c:\sc2.jpg") + "" + obj.get_width() + "" + obj.get_height() + "<br>");
    //show what is preserved
    app.shell_execute("open", "c:\sc2.jpg");
     
    //step 4
    echo("4.Save the image(simplified) by its name to a file:");
    echo(image.get_by_name("captcha1").screenshot("c:\sc2.jpg", true) + "<br>");
    //show what is preserved
    app.shell_execute("open", "c:\sc2.jpg");
     
    //end
    echo("<hr><br>");
     
    app.quit();
    }
    }

    Java Script example:

    //connect the object to control the emulator, if not already connected
    xhe_host = "127.0.0.1:7018";
    echo = require("../../../Templates JS/xweb_human_emulator.js");
     
    //Start
    echo("<hr> <font color = blue> interface.screenshot </font> <hr>");
     
    //1 step
    echo("1.Let's go to the polygon:");
    echo(browser.navigate("http://www.humanemulator.net/poligon/image.html") + "<br>");
     
    //step 2
    echo("2.Save the picture by its name to a file:");
    echo(image.get_by_name("captcha1").screenshot("c:\sc.jpg") + "<br>");
    //show what is preserved
    app.shell_execute("open", "c:\sc.jpg");
     
    //step 3
    echo("3.Save the picture by its name to a file and display the size of the picture in the browser:");
    obj = image.get_by_name("screen2");
    echo(obj.screenshot("c:\sc2.jpg") + "" + obj.get_width() + "" + obj.get_height() + "<br>");
     
    //step 4
    echo("4.Save the picture by its name to a file:");
    echo(image.get_by_name("captcha1").screenshot("c:\sc2.jpg", true) + "<br>");
    //show what is preserved
    app.shell_execute("open", "c:\sc2.jpg");
     
    //end
    echo("<hr><br>");
     
    //Quit
    app.quit();
  • en/objects/interface/action/screenshot.txt · Last modified: 2026/08/05 22:44 (external edit)