Manual > Control Reference > Route

The properties that a root object has are called root properties.

Property Name

explanation

script

action

browser

script

Arithmetic Expression

syntax

Comment

Comment for the route.

○

Enabled

Switch between enabled and disabled.

When disabled, keyboard input is not accepted. The Enabled root property affects all forms and all controls. Some controls are dimmed.

○

EnabledInput

Switch between enabled and disabled.

When disabled, keyboard input will not be accepted. The EnabledInput root property affects all forms and all controls. Unlike Enabled, the control will not be dimmed.

○

EnabledEvent

Enable or disable the event.

When disabled, all events (including root, form, and control) will stop being fired. This property is used by scripts while online, so it will not be displayed in the property page dialog.

○

Title

The text that appears in the window's title position, and also when you move the mouse over the browser icon if the browser is displayed as a taskbar icon.

○

TitleType

How the title will be displayed.

ROOT	Title Show root property as title
FORM	Displays the Title property of the form object as the title.
ROOT_FORM	Display the combination of the Title property of the root object and the form object in that order.
FORM_ROOT	Display the combination of the Title property of the form object and the root object in that order.

○

TitleParent

Whether to update the application title when embedding a browser in a user application created with Web Browser or VB, etc. Ignored when using a dedicated browser.

○

DefaultForm

The name of the initial form displayed when the browser is launched.

○

DefaultView

If you omit the ViewName argument of the following route methods (or specify an empty string), the view name specified in DefaultView will be used.

OpenHomeForm / ClearFormHistory / OpenPrevForm / OpenNextForm / IsHaveNextForm / IsHavePrevForm / GetCurrentForm / ResetZoom / SetZoom / GetZoom / SetStretch

*If the ViewName argument of the above method is omitted (or an empty string is specified) and the DefaultView root property is an empty string, "MainView" will be used.

○

DefaultFrame

Settings for frame display.

DefaultFireAlarm

Defines the default values used when calling the FireAlarm route method.

Define them in the following order:

alarmAction;alarmId;conditionId;commentId[;comment]

Multiple commentID,comment can be specified by separating them with commas.

Example: Event;system;1;0

By specifying the root property name as the comment for commentId, its value will be automatically included in the comment when FireAlarm is called.

Example: Event;system;1;0,1;,PSLoginUser // By calling FireAlarm("message");, the value of "message" will be set to [CM0] and the value of PSLoginUser will be set to [CM1].

○

HiddenForm

Specify the name of the form you want to open as a background form.

The background form is always open in an invisible state while the browser is running. Place controls and scripts that you want to run all the time in this form. You can also achieve the same behavior by setting the form's HiddenFrom property to TRUE.

○

Stretch

Stretch mode.

The form size will be automatically adjusted (enlarged or reduced) according to the following modes.

NONE	Display actual size (not stretched)
FORM	Match form settings
STRETCH_FULL	Stretch to fit
STRETCH_KEEPRATE	Stretch to fit size (maintain aspect ratio)
RESIZE_FULL	Adjust form size to fit your needs
RESIZE_KEEPRATE	Adjust form size to fit (keep aspect ratio)

*Difference between STRETCH_XXX and RESIZE_XXX

In the case of STRETCH_XXX, when the screen is expanded, the size of the form (Width/Height property) remains the same, and the zoom ratio is automatically adjusted to stretch the display. Therefore, all images and text are expanded or reduced. On the other hand, in the case of RESIZE_XXX, the zoom ratio remains fixed at 100%, and the actual size of the form (Width/Height property) is automatically adjusted. Therefore, the size of controls and text remains the same. If you want to automatically adjust the position and size of controls on the screen when the screen is expanded, set the AutoResizeX/AutoResizeY property of each control. For example, if you specify "RIGHT" for AutoResizeX, the position of the control will automatically move to the right side when the screen is expanded.

○

RefreshRate

Screen update period (ms).

A value of 0 will use the default interval (recommended). If you want to reduce the load on the CPU, adjust the refresh interval to a larger value. RefreshRate can be changed during operation. For example, you can change the RefreshRate in the OnInitialize event of each form as follows:

event OnInitialize()

{

::RefreshRate = 1000; // Change the refresh rate of this screen to 1 second.

}

○

EscToReleaseFullScreen

Whether to exit full screen mode when the ESC key is pressed.

Only valid for dedicated browsers.

○

Inifile

The initial setting file name.

If you want to define the initial values of root properties or form properties in an external text file, specify the file name.

○

InifileSection

Section name when using Inifile.

In the initial value configuration file, be sure to specify the section name set with InifileSection. (If you are using an inifile for other purposes, this is to distinguish it from other sections.)

Example of initial value setting file)

[Property]

Title=Central Monitoring System

PSNode=192.168.1.1

[xxx(Other section name)]

Xxx = xxx

In addition to the root property, you can also define form properties in the initial configuration file (INI file). When defining form properties, please write them in the following format.

Format:

Folder name.Form name.Property name=Value

example

Folder01.Form01.Comment=ABCDE

○

StartupMonitor

In the case of multiple monitors, specify the monitor number to be displayed at startup.

0 is the primary monitor, 1 or higher is the sub monitor

○

StartupSize

The size of the browser when it was launched. Only valid for dedicated browsers.

STANDARD	Standard size.
FULLSCREEN	Full Screen: The form fills the entire desktop.
DEFAULTFORM	The form size set in DefaultForm.
MAXIMUM	Maximum display.
MINIMUM	Minimum display.
CUSTOMSIZE	The size is specified by the user. The value of StartupSizeWidth/StartupSizeHeight will be the size of the form.
CUSTOMSIZE2	The size is specified by the user. The value of StartupSizeWidth/StartupSizeHeight will be the size of the application.
TASKBARICON	Iconize on the taskbar.

○

StartupSizeWidth

Screen width. Only valid when StartupSize is set to CUSTOMSIZE/CUSTOMSIZE2.

○

StartupSizeHeight

Screen height. Only valid when StartupSize is set to CUSTOMSIZE/CUSTOMSIZE2.

○

WindowMinWidth

The minimum limit size (width) when the browser is resized smaller.

If the value is 0, there is no limit. (Only compatible with standard browsers. Not compatible with IE.)

○

WindowMinHeight

The minimum limit size (height) when the browser is resized smaller.

If the value is 0, there is no limit. (Only compatible with standard browsers. Not compatible with IE.)

○

StartupCenter

Set the browser's display position to the center of the desktop when it is executed.

○

StartupPosLeft

Specifies the display position (left coordinate) when the browser is launched.

Valid when StartupCenter is FALSE. When it is -1, it is displayed in the default position. Valid only for the dedicated browser.

○

StartupPosTop

Specifies the display position (top coordinate) when the browser is launched.

Valid when StartupCenter is FALSE. When it is -1, it is displayed in the default position. Valid only for the dedicated browser.

○

StartupWaitingTime

Startup wait time (in ms).

It is used to adjust the startup timing with the server, for example when starting automatically in the startup folder.

○

ShowStatusBar

Shows/hides the status bar while the browser is running.

○

ShowMenu

Shows/hides the menu while the browser is running.

○

ShowFullScreenMenu

Shows/hides the menu when the browser is running in full screen mode.

○

ShowMaxButton

Shows/hides the largest button on the right of the title bar while the browser is running.

○

ShowMinButton

Shows or hides the smallest button on the right of the title bar while the browser is running.

○

ShowTitleBar

Shows or hides the title bar while the browser is running.

○

ShowSystemMenu

Shows/hides the system menu while the browser is running.

○

ShowBrowserBorder

Show/hide the browser border (the sunken frame).

When using frame display, setting it to FALSE will prevent the double depression and allow for a neater display.

○

ViewFillColor

Background color of the view (outside the form).

If you specify no color for the form's ViewFillColor property, the ViewFillColor root property is used.

○

FocusHoverType

The type of rectangle that indicates focusability when the mouse is moving over a control.

DOUBLE1	Double line (default)
SINGLE1	Single line (1 pixel thick)
SINGLE2	Single line (2 pixels thick)
SINGLE3	Single line (3 pixels thick)

○

FocusHoverColor1

Color of the rectangle that indicates focus is possible when the mouse is moving over the control. Inner color if FocusHoverType is DOUBLE1. Line color if SINGLE1/2/3.

○

FocusHoverColor2

The color of the focusable rectangle when the mouse is moving over a control. If FocusHoverType is DOUBLE1, the outer color.

○

MaxFormHistory

The maximum number of forms that have been opened.

This history is used by OpenPrevForm/OpenNextForm.

○

BindWatchTime

The default value for the state inconsistency monitoring time (in seconds) when you specify the "WATCH" format in a bind.

For more information, see "I/O Binding Format" in "Binding".

○

AllowShutdown

Whether or not it is okay to close the dedicated browser.

After the root event OnShutdown is called,

AllowShutdown is evaluated and if it is FALSE, the shutdown request is canceled.

○

AllowResize

When set to FALSE, the window size cannot be changed after the browser is launched.

○

AllowZoom

The default value for whether to allow the screen zoom function (enlargement, reduction).

If the form property AllowZoom is set to "DEFAULT", the value of the root property will be used.

○

ToolTipFont

The font used to display tooltips.

The text to be displayed in the tooltip is specified in the ToolTipText field of the form.

○

ToolTipOffsetX

The tooltip is displayed offset in the X direction from the mouse position.

○

ToolTipOffsetY

The tooltip is displayed shifted in the Y direction from the mouse position.

○

ToolTipTimer

You can specify the time in milliseconds for the tooltip to be hidden after it is displayed. Specifying 0 will disable the timer setting.

○

KeepProcess

Monitor the Browser process.

By setting True, Browser will automatically restart if it is terminated abnormally. This property is only valid when running from Browser, and is disabled when running from Editor. To enable it,

You will need "ProcessKeeper3.exe". Make sure this EXE is included in the installation folder.

DeveloperMode

If set to TRUE, the size and name of the view on the screen will be displayed.

○

ShowCommentProperty

The property name used for comments displayed when you select "View" and "Show Comments" from the browser menu.

For example, if you specify "Name", the object name will be displayed as a comment. If you want to display multiple properties at the same time, separate them with a comma (,). Example: Name,Comment

○

ShowCommentChildLevel

The hierarchy of comments that is displayed when you select "View" and "Show Comments" from the browser menu.

If you do not want to display comments for grouped controls, specify 1. Specify -1 to display comments for all levels.

○

Property Name

explanation

script

action

browser

script

Arithmetic Expression

syntax

PSLoginMust

The PSLoginMust root property (TRUE/FALSE) controls whether the client runtime is allowed to start even if the user is not logged in.

To log in, the server must be running on another PC on the network or on the same PC as the browser. If the server is not running or if the user name or password is incorrect, login will fail, but you can set whether or not to start the system (display the form) in that case.

TRUE - Login is required. The system will not start until login to the server is successful. If communication with the server becomes impossible for some reason after login is complete, automatic retries will be performed until the server is found. Once the server is found, reauthentication will be performed, and if OK, login will be performed. If NG, the login screen will be displayed.

FALSE - Login is not required. The system will start without logging in to the server. The server will remain unconnected until you log in using the automatic login (Login method) or manual login (OpenLoginForm). If communication with the server becomes impossible for some reason after login is complete, automatic retries will be performed until the server is found. Once the server is found, reauthentication will be performed, and if OK, login will be performed, and if NG, retrying will end.

○

PSLoginStartup

Specifies how to log in when the system starts.

NONE

Do not log in.

1) However, if the PSLoginMust route property is TRUE, the NONE setting is ignored and the login screen is displayed.

2) If the PSLoginMust route property is FALSE, the user will remain disconnected until they log in automatically (using the Login method) or manually (using the OpenLoginForm method).

AUTO

Automatic login.

The login screen will not be displayed, and the user will automatically be logged in using the username and password set in the PSLoginUser route property / PSLoginPwd route property. If the login fails and the PSLoginMust route property is TRUE, the login screen will be displayed.

MANUAL

Manual login.

The login screen is displayed, and the operator must enter a username and password to log in. If the login fails, and the PSLoginMust route property is TRUE, the system will not start and the login screen will continue to be displayed until the login is successful.

If you have not successfully logged in to the server, the browser cannot receive information from the server, such as tags, alarms, historical records, databases, files, etc. In addition, all functions (see below) and controls for inputting and outputting external information (DirectQueryDb control, VideoPlayer control, VideoRecorder control, etc.) are also locked at the same time. In addition, methods for inputting and outputting data in ActiveX are also locked.

Route Methods

LoadTextFile / SaveTextFile / LoadCsvFile / SaveCsvFile / SavePrintText

Grid control Method

LoadCsvFile / SaveCsvFile

(In other words, unless a valid login is performed, the browser process cannot perform any input or output outside the process. This mechanism allows data input and output to be made available only to users who have completed login authentication and are deemed safe.)

○

PSLoginStartupError

Sets the error dialog when login fails.

TRUE	When the login method at system startup is AUTO, if login fails an error dialog will be displayed.
FALSE	When the login method at system startup is set to AUTO, no error dialog will be displayed even if login fails.

○

PSLoginMenu

How to log in when selecting the browser menu (operation-login/logout).

NONE	Do not log in from the menu.
AUTO	Automatically logs in when you select Login from the menu.
MANUAL	When you select Login from the menu, you will be logged in manually.

○

PSLoginScreen

NORMAL	Normal login screen
DISABLE_CANCEL	Disable the Cancel button
DISABLE_USERPWD	Disable Username and Password
DISABLE_CANCEL_USERPWD	Disable the cancel button, username, and password

If you disable the username and password, the operator will not be able to change the username and password on the login screen. Also, if you disable the Cancel button, the operator will not be able to cancel the login. Note that the Cancel button is automatically disabled when the PSLoginMust route property is TRUE.

○

PSLoginUser

The user when logging in automatically or with the Login method.

○

PSLoginGroup

The groups the user will belong to upon login.

○

PSLoginPwd

Password used for automatic login or logging in using the Login method.

○

PSLoginComment

Comments by logged-in users.

With the direct login function, you can set any string for each login user by specifying it in the login INI file.

○

Property Name	explanation	script action	browser script	Arithmetic Expression syntax
PSTimeOut	The timeout period for communication with the server (in seconds). Set a few seconds depending on your network environment (generally around 20 seconds). If a process takes a long time, such as retrieving a large amount of data with Historical data server or creating and retrieving a Excel file with Daily/Monthly/Yearly Report, please note that if this PSTimeOut root property is too short compared to the processing time, a timeout error will occur. In such cases, adjust the time you set (however, making this timeout time too long has the disadvantage that it will take longer to detect a communication error if communication is interrupted due to some problem).	×	○	×
PSTimeOutConnect	The timeout period (in seconds) for connecting to the server. When running the server and browser on the same PC, you usually set this to "-1." If you are running the server and browser on different PCs and are having trouble connecting, try adjusting this timeout period (usually around 5 to 10 seconds).	×	○	×
PSNodeRedundancy	If you want to duplicate it, set it to True.	×	○	×
PSNode	The node name of the server. If you run the server and the browser on different PCs, you must specify the server's IP address or node name. If you run them on the same PC, you can leave this blank.	×	○	×
PSNode2	The node name of the sub-machine's server. This setting is only required if you have duplicated the system. Note that this setting is only valid when PSNodeRedundancy is True.	×	○	×
PSPanelPort	The server port number. The default port on the server side is 6001.	×	○	×
PSPanelPort2	The port number of the secondary machine's server. This setting is required only if you have duplicated the system. Node name. This setting is required only if you have duplicated the system. This setting is only valid when PSNodeRedundancy is True.	×	○	×
PSPing	Before connecting to the server, use the Ping command to check whether the server PC is active. If you check with Ping, the time it takes to recognize a connection error will be stable, regardless of the PSTimeOutConnect setting, such as when the server PC is not running. If you connect via the Internet, the target device (such as a router) whose IP the browser connects to must support the Ping command. For security reasons, set this to FALSE if you do not want to make the Ping command public.	×	○	×
PSFilePath	The server configuration file that is automatically loaded when you start the server using the editor's Run Server button.	×	○	×
PSTagAccessPath	The access path of the tag. Use this when you want to abbreviate part of the tag path. For example, if you specify "U01.F01.", the binding setting for the tag U01.F01.T01 can be abbreviated to just "T01".	×	○	×
PSTagDirectPathMark	When an access path is set in PSTagAccessPath, this is an identification character (the default is an underscore "_") to ignore the access path and specify the tag path as an absolute path. If you specify an access path, all tag references must be specified by tag name without the access path. If you want to ignore the access path and specify an absolute path directly, you can specify the absolute path by adding the character specified in this property to the beginning of the tag path. For example, if you specify "U01.F01." as the access path, you will not be able to specify other PLC such as "U02" or tags in other folders such as "U01.F02". In such a case, you can ignore the access path setting by adding "_" (default setting) to the beginning and specifying "_U02.F01.T01" etc. Do not use prohibited characters in the characters specified for this property. For more information,Please refer to "Naming Rules".	×	○	×
PSTagUpdateRate	Update period for communication with the server (in ms).	×	○	×
PSTagDebug	Whether to perform virtual communication to external tags. When set to TRUE, external tags are virtually communicated with. Use this when debugging. In this state, you can read and write the values of external tags within the browser without connecting to the server.	×	○	×
PSUserLevel	The user level (an integer value). The level value of the user who successfully logged in is set. For details, please refer to "Implementing logic based on user level".	×	○	×
PSUserAuth	Authority string. If the user belongs to a group, the authority string of the group will be set after logging in. If the user is not logged in, the string will be blank. Please note that if the user logs out due to unstable communication, this property will be blank during that time.	×	○	×
PSUserParam	The user's parameter string.	×	○	×

Route Properties

Route Properties