HTML Viewer
How To Use The HTML Viewer DLL
Background
Argent BoardRoom is a presentation technology that allows you to quickly create custom screens and playlist from a variety of sources. Using Argent BoardRoom, you can configure big screen displays and CIO desktops of your enterprise infrastructure.
Argent BoardRoom Playlists are composed of Screens, which are in turn, composed of Frames. Each Argent BoardRoom Frame must use a Registered DLL to define the Frame’s Source. Among the myriad pre-defined Registered DLLs included with Argent BoardRoom is the HTML Viewer DLL. This DLL allows the Frame to display a Web URL.
This document explains how to configure the HTML Viewer DLL.
Create A New Screen
For example purposes, we’ll create a new Argent BoardRoom Screen that consists of a single Frame using the HTML Viewer DLL.
Start by select the BoardRoom Screens tab on the left side of the user interface.
Right-click in the tree-view pane and select New BoardRoom Screen.
Give the new Screen a title, such as My Yahoo Finance in the Example:
Note the Screen consists of a single Frame by default. Click on the Registered DLL drop-down list to select the HTML Viewer DLL. Right-click on the Frame and Save.
Configuring the Frame
Right-click on the Frame and choose Design Currently Selected Frame.
Set the following Properties for the Frame:
URL: http://finance.yahoo.com
Other Frame Properties you can set are documented in ‘Frame Properties’ below.
Click OK and note the URL is loaded into the Frame. Right-click and Save.
So far everything looks good. If you like you can preview the Screen by clicking on the green Play button in the upper left of the window:
Let’s make this screen a bit more personal by using the My Yahoo! Finance page URL at http://finance.yahoo.com.
Click on the “Sign In” link, taking you to the Yahoo! Sign In page:
https://login.yahoo.com/config/login?.done=http://finance.yahoo.com%2f&.src=quote&.intl=us
Follow the guidance in the next section, Form Logon Script.
Form Logon Script
The Form Logon Script Property allows you to specify a Visual Basic script to run in the event the URL requires a username and password combination. Argent recommends using Argent Defender to record the session, then copy and paste the session into the Argent BoardRoom Form Logon Script.
Notes: The HTML Viewer DLL supports a subset of the Argent Defender keywords and does not require the initial Navigate statement.
Use Argent Defender Recorder to load the URL and record the login and navigation to the desired page for your Argent BoardRoom Screen. You should end up with something like this in the Session editor of Argent Defender:
‘Session Created: 12 Mar 2010 15:59:53
‘Session Updated: 12 Mar 2010 16:06:17
‘Technology Copyright (c) ArgSoft Intellectual Property Holdings, Limited. 1991-2009
TextBox ( “login_form”, “login” ) = “argent.software@yahoo.com”
Password ( “login_form”, “passwd” ) = Decode(“{\187\247\167\179\164\164\165\174\172\248}”)
CheckButton ( “login_form”, “.persistent” ) = False
Button “Submit”, “login_form”, “.save”
Copy the highlighted portion (of your script) and paste into Argent BoardRoom’s HTML Viewer DLL Form Logon Script Property and click OK:
Click OK again, then right-click to Save.
Click the green Play button to preview your Screen:
Appendix: Argent BoardRoom HTML Viewer DLL
Frame Properties
Frame Property | Optional/Default Value | Meaning |
URL | n/a | The URL to load in the Frame. |
Display As Bitmap | True/False | Render the URL as an image instead of as Web page |
Picture Width | 1204 | If Display As Bitmap is True, the width of the rendered image. |
Picture Height | 768 | If Display As Bitmap is True, the height of the rendered image. |
Keep Aspect Ratio | True/False | If Display As Bitmap is True, maintain the aspect ratio defined by Picture Width and Picture Height if the Frame is of a different size. |
Shrink Picture Only | True/False | If Display As Bitmap is True, only downscale the rendered image. |
Show Page Loading | True/False | If false, nothing displays until the page is completely loaded. |
Max Wait Seconds | 10 | |
Form Logon Script | n/a | Script to run if URL requires username / password combination |
Border Width % | 0 | Size of Frame Border |
Border Color | Red = 191 Green = 219 Blue = 255 |
Color of Frame Border |
Double Click | ||
Operation | Do Nothing | Double click on Screen does nothing |
Jump To Screen | Double click jumps to another BoardRoom Screen | |
Launch Program | Double click launches external program | |
Show Message | Double click displays a Message dialog box | |
BoardRoom Screen | If Operation is Jump To Screen, double click jumps to this Screen | |
Program | If Operation is Launch Program, double click launches this Program | |
Parameters | If Operation is Launch Program, Program is launched with these Parameters | |
Message | If Operation is Show Message Box, double click displays this Message in a dialog box |
Appendix: Argent BoardRoom HTML Viewer DLL
Form Logon Script: Supported Argent Keywords
Properties
Property | Syntax | Meaning |
CheckButton | CheckButton( form_name, checkbox_name ) = b | “Note: Write-only.
Use this keyword to check or uncheck checkbox ‘checkbox_name’ in form ‘form_name'” |
List | List( form_name, list_name ) = text | Use this keyword to select the item ‘text’ in list ‘list_name’ on form ‘form_name’ |
Password | Password( form_name, field_name ) = text | “Use this keyword to enter the password in the password field ‘field_name’ in form ‘form_name’.
The text should use the Argent Method ‘Decode’ to avoid a plain-text password.” |
RadioButton | RadioButton( form_name, radiobutton_name ) = text | Use this keyword to check or uncheck radiobutton ‘radiobutton_name’ in form ‘form_name’ |
TextArea | TextArea( form_name, field_name ) = text | Use this keyword to enter the text in the text-area field of ‘field_name’ in form ‘form_name’. |
TextBox | TextBox( form_name, field_name) = text | “Note: Write-only.
Use this keyword to enter text; enter the text into field ‘field_name’ in form ‘form_name’.” |
Appendix: Argent BoardRoom HTML Viewer DLL
Form Logon Script: Supported Argent Keywords
Methods
Method | Syntax | Meaning |
Button | Button form_name, button_name | This keyword is used to identify that a button has been depressed or selected.
Often times buttons reference links or form update actions. |
Decode | variable = Decode(encrypted_password) | This keyword decrypts the encrypted password. |
DisableNewWindow | DisableNewWindow value | When this value is True, no popup Html pages can be shown.
It effectively turns off any advertisements or secondary popup windows. |
Display | Display text | This keyword writes the specified text to the Argent Defender task log.
This is an extremely useful debugging facility. |
ElementClick | ElementClick name, parent_element, mouse | This keyword executes a click on the simple element (DIV and SPAN) ‘name’.
The parameter ‘parent_element’ is the unique identifier for the parent element. The parameter ‘mouse’ is the bitwise combination of the following values depending on what mouse event is handled by the object: |
#define INPUT_ELEMENT_MOUSE_DOWN 1
#define INPUT_ELEMENT_MOUSE_UP 2 #define INPUT_ELEMENT_MOUSE_CLICK 4 #define INPUT_ELEMENT_MOUSE_SIMPLE_CLICK 8 #define INPUT_ELEMENT_MOUSE_OVER 16 |
||
EnterKey | EnterKey form_name | This keyword presses the Enter key on the keyboard while form ‘form_name’ has the input focus. |
ImageButton | ImageButton form_name, image, wait_in_seconds | This keyword executes a click on the image button ‘image’ in form ‘form_name’.
The delay is specified in seconds. |
ImageClick | ImageClick name, parent_element, mouse | This keyword executes a click on the image ‘name’.
The parameter ‘parent_element’ is the unique identifier for the parent element. The parameter ‘mouse’ is the bitwise combination of the following values depending on what mouse event is handled by the object: |
#define INPUT_ELEMENT_MOUSE_DOWN 1
#define INPUT_ELEMENT_MOUSE_UP 2 #define INPUT_ELEMENT_MOUSE_CLICK 4 #define INPUT_ELEMENT_MOUSE_SIMPLE_CLICK 8 #define INPUT_ELEMENT_MOUSE_OVER 16 |
||
TableCellClick | TableCellClick name, parent_element, mouse | This keyword executes a click on the table cell ‘name’..
The parameter ‘parent_element’ is the unique identifier for the parent element. |
#define INPUT_ELEMENT_MOUSE_DOWN 1
#define INPUT_ELEMENT_MOUSE_UP 2 #define INPUT_ELEMENT_MOUSE_CLICK 4 #define INPUT_ELEMENT_MOUSE_SIMPLE_CLICK 8 #define INPUT_ELEMENT_MOUSE_OVER 16 |
||
Wait | Wait seconds | This keyword specifies – in seconds – the time to pause the script. |