Smartframe Newlook Control API

Smartframe is an executable, looksoftware.SmartFrame.exe, which contains it's own Chromium-based browser, allowing you to load a custom HTML and JavaScript framework, that surrounds, and interacts with, the Smartframe Newlook Control using the Smartframe Newlook Control API.

All Smartframe templates installed with Newlook Developer, include a Smartframe.HTML file, which hosts the Smartframe Newlook Control. The object can be found inside the RuntimeContainer div and is represented by the following object tag:

</object>

This object represents the Smartframe Newlook Control.

Known Limitations

If there are HTML comments inside the newlook object opening and closing tags, and no other parameters, the Newlook control will render at zero width and height. To prevent this, it is recommended that any comments are moved outside the object tag.

Smartframe Newlook Control API

When embedded in a HTML page, the Smartframe Newlook Control provides the following startup parameters, properties, events and methods which you can use to interact with it:

Startup Parameters

Parameter	Description
BackColor	This startup parameter determines the back color of certain Smartframe Newlook control toolbar elements (typically used to set the background color of the title bar and function key bar for pop ups forms).
ForeColor	This startup parameter determines the text color of certain toolbar elements in the Smartframe Newlook Control (typically used to set the color of title bar text for pop up forms).
HideConnectionDialog	This startup parameter of the Smartframe Newlook Control prevents the connection progress dialog window from displaying when a session is connecting.
HideToolbars	This startup parameter determines whether toolbars will be displayed in the Smartframe Newlook Control, and if so, which ones.
MultiSessionEventsFilter	This startup parameter allows you to specify which events will be triggered in hidden sessions running in the Smartframe Newlook Control.
Options	This parameter determines the command line parameters to run when the Smartframe Newlook Control starts.

Properties

Property	Description
DesiredClientSize	Read only. Returns a structure containing the recommended client Width and Height to prevent scrollbars from displaying.

Events

Event	Description
OnConnectStateChanged	This event is triggered each time the user connects or disconnects in the Newlook Control.
OnDesiredClientSizeChanged	This event is triggered each time the DesiredClientSize property of the Smartframe Newlook Control changes.
OnFunctionKeyChanged	This event is triggered each time a new array of function keys is received in the Newlook Control.
OnOpened	This event is triggered when an added form is opened in the Newlook Control.
OnReceived	This event is triggered each time a new screen is received from the host in the Newlook Control.
OnRefreshed	This event is triggered each time a screen is refreshed in the Newlook Control.
OnSent	This event is triggered each time a screen is sent back to the host in the Newlook Control.
OnStatusChanged	This event is triggered when the host session status changes in the Newlook Control.
OnTitleChanged	This event is triggered when the screen title changes in the Newlook Control.
OnViewChanged	This event is triggered each time the user switches between GUI and Emulator mode in the Newlook Control.

Methods

Method	Description
GetJSONValue	Retrieves data from the Newlook control as a JSON formatted string.
GetValue	Retrieves the value of a variable or object property from the Newlook Control.
Invoke	Enables direct calls to any Newlook object method.
RunMacro	Runs the specified Newlook macro.
SendKeys	Issues keystrokes to the Newlook Control.
SetValue	Sets the value of a Newlook variable or object property.

Smartframe Newlook Control API

Known Limitations

Smartframe Newlook Control API

Startup Parameters

Properties

Events

Methods

See Also