Manual > Control Reference > Routes

Common Methods

Method name

explanation

For details, please refer to Common Methods. However, the following methods are excluded.

HitTest/ SetFocus/ LostFocus/ StartDrag/ StartDragX/ StartDragY/ StopDrag

Route Methods

Method name	explanation	script action	browser script	Arithmetic Expression syntax
OpenForm	Open the form.	×	○	×
OpenViewForm	Opens the form in the specified view.	×	○	×
OpenPrevForm	Open the previous form.	×	○	×
OpenNextForm	Open the following form:	×	○	×
ClearFormHistory	Clear the form open history.	×	○	×
OpenHomeForm	Open the default form.	×	○	×
GetCurrentForm	Gets the name of the currently open form.	×	○	×
GetForm	Gets the specified form object.	×	○	×
IsHavePrevForm	Is there a previous form?	×	○	×
IsHaveNextForm	Do you have the following form?	×	○	×
OpenHiddenForm	Open the background form.	×	○	×
AddResourceFile	Adds a form defined in a file other than the currently open configuration file (xml file) as a resource.	×	○	×
OpenFile	Open the configuration file (xml file).	×	○	×
OpenBrowser	Launch a new browser (dedicated browser) and open the file.	×	○	×
CloseBrowser	Close the browser (dedicated browser).	×	○	×
OpenApplication	Open an external application.	○	○	×
OpenApplicationFile	Open a file in an external application.	×	○	×
AddRecentFilePath	The browser adds the file to its open history.	×	○	×
GetRecentFilePath	Get the browser's history of open files.	×	○	×
ClearRecentFilePath	Clear all browser history of opened files.	×	○	×
GetOpenFileType	Gets the type of browser file retrieval method.	×	○	×
ShowFullScreen	Make the browser (dedicated browser) full screen (fill up the entire desktop).	×	○	×
ShowTaskbarIcon	Display the browser (dedicated browser) as an icon on the taskbar.	×	○	×
RefreshScreen	Forces the screen to be redrawn.	×	○	×
ZoomIn	Displays a magnifying cursor for zooming with the mouse.	×	○	×
ResetZoom	Release the zoom.	×	○	×
SetZoom	Specify the zoom ratio to enlarge or reduce the image.	×	○	×
GetZoom	Gets the zoom factor.	×	○	×
SetZoomInRatio	After calling the ZoomIn method, sets the zoom ratio when you click the magnification point.	×	○	×
GetZoomInRatio	After calling the ZoomIn method, obtain the zoom ratio when you click the magnification point.	×	○	×
SetStretch	Change the stretch mode.	×	○	×
GetActiveDialogName	Gets the name of the active dialog.	×	○	×
GetActiveViewName	Gets the name of the active view.	×	○	×
GetAllDialogName	Returns an array of view names of currently open dialogs.	×	○	×
SetModalDialog	Displays a modal dialog (displayed in the foreground, cannot operate other windows, and cannot be moved forward/backward).	×	○	×
ShowDialog	Changes the visibility of the dialog.	×	○	×
BringDialogToTop	Brings the currently displayed dialog to the front.	×	○	×
BringBrowserToTop	Bring the browser to the front.	×	○	×
SetDialogState	Toggles between maximum and minimum display of the dialog.	×	○	×
EnableDialogMenu	Shows or hides the maximize, minimize, and close buttons of the dialog.	×	○	×
GetMenuCandidate	Gets information about the form for menu display candidates.	×	○	×
SetBrowserState	Change the browser display format.	×	○	×
GetBrowserState	Gets the browser display format.	×	○	×
GetBrowserType	Gets the type of Browser that is currently running.	×	○	×
ShowComment	Show comments.	×	○	×
UpdateTitle	Update the title.	×	○	×
SetMouseCursor	Specifies the mouse cursor.	×	○	×

Permissions related

Method name	explanation	script action	browser script	Arithmetic Expression syntax
StrLen	Gets the number of characters in a string.	○	○	○
MBStrLen	Gets the number of bytes in a string.	○	○	○
LeftStr	Extracts the left part of a string.	○	○	○
RightStr	Extracts the right part of a string.	○	○	○
MidStr	Extracts the middle part of a string.	○	○	○
FindStr	Search for a character in a string.	○	○	○
IsLike	Searches for characters in a string to determine whether they match.	○	○	○
InsertStr	Insert characters.	○	○	×
RepeatInsertStr	Insert characters repeatedly at regular intervals.	○	○	×
CombineStr	Combines characters (especially in the case of arrays).	○	○	○
DivideStr	Searches for a separator character and splits the string into left and right halves.	○	○	×
TrimLeftStr	Removes spaces (or a specified character) from the beginning of a string.	○	○	○
TrimRightStr	Removes spaces (or a specified character) from the end of a string.	○	○	○
UpperStr	Converts a string to upper case.	○	○	○
LowerStr	Converts a string to lower case.	○	○	○
ReplaceStr	Replaces the specified characters with other characters.	○	○	○
ReverseStr	Reverses the specified string.	○	○	○
CStrToArray	Converts a string into an array using the separator string as a delimiter.	○	○	○
CArrayToStr	Converts an array to a string with a separator string appended.	○	○	○
CCsvToArray	Convert a CSV string to an array.	○	○	○
CArrayToCsv	Convert an array to a CSV string.	○	○	○
Chr	Returns the character corresponding to the specified ASCII code.	○	○	○
Ascii	Returns the ASCII code for the specified character.	○	○	○
RET	Returns the line feed character.	○	○	○
IntStrs	Generates a string array of consecutive numbers.	○	○	○
IsFullWidthChar	Determines whether a character (string) is full-width.	○	○	×
MeasureStr	Gets the size of the text characters.	×	○	×

Method name	explanation	script action	browser script	Arithmetic Expression syntax
Revar	Redeclare an array of variables.	○	○	×
GetQuality	Gets the quality flag of the value. ("GOOD" or "BAD" or "UNCERTAIN")	○	○	○
IsQualityGood	Checks if the value's quality flag is GOOD.	○	○	○
IsQualityBad	Checks if the quality flag of a value is BAD.	○	○	○
IsQualityUncertain	Checks if the quality flag of a value is UNCERTAIN.	○	○	○
GetValueDimension	Find the number of dimensions of a value.	○	○	○
GetValueElement	Find the number of elements for each dimension of the value.	○	○	○
GetValueTotalElement	Calculate the total number of elements in a value.	○	○	○
GetValueType	Determine the data type of a value.	○	○	○
IsBool	Checks if a value is a Boolean type.	○	○	○
IsNum	Checks whether a value is a numeric type.	○	○	○
IsStr	Checks whether a value is of type character.	○	○	○
IsTime	Checks if a value is a time type.	○	○	○
IsObj	Checks whether a value is of type object.	○	○	○
IsNullObj	Check whether the object is in a null state (NULL).	○	○	○
IsValid	Check whether the value is valid (not #NOTHING# or #N/A#).	○	○	○
IsValidStr	Check whether the value is a valid character (not #NOTHING# or #N/A#, and not the empty string).	○	○	○
CBool	Converts a value to a Boolean type.	○	○	○
CNum	Converts a value to a numeric type.	○	○	○
CStr	Converts a value to a string.	○	○	○
CBit	Extracts bits from the given number.	○	○	○
CTime	Converts a value to a time type.	○	○	○
CScript	Converts a value into a string representation for use in scripts.	○	○	○
CScriptTo	Converts a string representation of a value used in a script to a value.	○	○	○
CNumToLocale (NL)	Converts a number to a locale-aware numeric string.	○	○	○
CLocaleToNum (LN)	Converts a locale-aware numeric string to a number.	○	○	○
CTimeToLocale (TL)	Converts a time type to a locale-appropriate date and time string.	○	○	○
CLocaleToTime (LT)	Converts a locale-appropriate date and time string to a time type.	○	○	○
DST	Determine whether it is daylight saving time (Day, Light, Saving) from the date and time.	○	○	○
CNumStr (NS)	Creates a numeric string specified by the format (old method).	○	○	○
CTimeStr (TS)	Converts a value to a time string (old method).	○	○	○
CTimeSpanStr	Converts a value to a time duration string.	○	○	○
CDurationStr	Converts a value to a duration format string.	○	○	○
CNumToHex	Converts a value to a hexadecimal string.	○	○	○
CNumToOct	Converts a value to an octal string.	○	○	○
CNumToBin	Converts a value to a binary string.	○	○	○
CNumToExp	Converts a value to a string in exponential notation (e.g. 1.23e+001).	○	○	○
CHexToNum	Converts a hexadecimal string to a value.	○	○	○
COctToNum	Converts an octal string to a value.	○	○	○
CBinToNum	Converts a binary string to a value.	○	○	○
CNumToComma	The number is converted to numeric characters separated by commas (,) every three digits.	○	○	○
CCommaToNum	Converts numeric characters separated by commas (,) into numbers every three digits.	○	○	○
CLinearToPf	Convert the original value into a power factor value.	○	○	○
CPfToLinear	Convert the power factor value back to its original value.	○	○	○
CTable	Converts a one-dimensional array to a two-dimensional array.	○	○	×
CValidTable	Converts a one-dimensional array to a two-dimensional array.	○	○	×
SelectVal (SV)	Select a value according to a condition.	○	○	○
GetRemainder	Find the remainder of value1 / value2.	○	○	○
Nums	Creates an array of consecutive numbers.	○	○	×
RepeatValue	Create an array with the same values.	○	○	×
SortValue	Sorts values in ascending or descending order.	○	○	×
SortTable	Sorts table information in ascending or descending order.	○	○	×
GetUniqueValue	Remove duplicate values from an array and sort it in ascending or descending order.	○	○	×
IsExist	Determines whether a value exists in a comparison list (array).	○	○	○
AddTableRow	Adds a row to a table array variable.	○	○	×
InsertTableRow	Inserts a row into a table array variable.	○	○	×
DelTableRow	Deletes a row from a table array variable.	○	○	×
ExchangeTableColRow	Swaps rows and columns of a table array variable.	○	○	×
MergeValue	Combines the elements of a value into a one-dimensional array.	○	○	○
EncryptStr	Encrypt a string.	○	○	×
DecryptStr	Reverts the encrypted string.	○	○	×

MAP

Mouse related

Method name	explanation	script action	browser script	Arithmetic Expression syntax
LoadTextFile	Read a text file.	○	○	×
SaveTextFile	Write to a text file.	○	○	×
LoadCsvFile	Read CSV file.	○	○	×
SaveCsvFile	Write to a CSV file.	○	○	×
SavePrintText	Creates a text file formatted for printing.	○	○	×
GetTempFolder	Gets the path of the Windows temporary folder.	○	○	×
GetTempFile	Gets the temporary file name.	○	○	×
GetCurrentFolder	Gets the path of the current folder.	○	○	×
GetModuleFolder	Gets the folder of the launched application.	○	○	×
GetFileSize	Get the file size.	○	○	×
GetFileLastWriteTime	Get the file modification time.	○	○	×
GetLogicalDrives	Gets the currently available disk drives.	○	○	×
GetDriveType	Determines the type of a specified drive.	○	○	×
EncryptFile	Encrypt files.	○	○	×
DecryptFile	Recover encrypted files.	○	○	×
SetClipboardData	Sets data to the Windows clipboard.	○	○	×
GetClipboardData	Gets data from the Windows clipboard.	○	○	×
GetSystemResource	Gets the file name of a system resource.	×	○	×
SetConfig	Set the configuration information.	×	○	×
GetConfig	Get configuration information.	×	○	×
SaveConfig	Save the configuration information.	×	○	×
SendFile	Send the file to the server's public folder.	×	○	×
ReceiveFile	Receive files in the public folder from the server.	×	○	×
CancelSendFile	Cancels an asynchronous send request made by SendFile.	×	○	×
CancelReceiveFile	Cancels an asynchronous send request made by ReceiveFile.	×	○	×
ServerBrowseFolder	List the files and child folders contained in the public folder.	×	○	×
ServerMakeFolder	Create a folder in the public folder.	×	○	×
ServerDeleteFile	Delete the files in the public folder.	×	○	×
ServerDeleteFolder	Delete the folder in the public folder.	×	○	×
ServerRenameFile	Rename the file in the public folder.	×	○	×
ServerRenameFolder	Rename the folder in the public folder.	×	○	×

Alarm

Indirect

Theme

Method name	explanation	script action	browser script	Arithmetic Expression syntax
Math.Abs	Find the absolute value.	○	○	○
Math.Ceil	Find the rounded up number.	○	○	○
Math.Floor	Find the rounded down number.	○	○	○
Math.Ave	Finds the average value from an array.	○	○	○
Math.Sum	Calculate the sum of an array.	○	○	○
Math.Max	Find maximum value from array.	○	○	○
Math.Min	Find minimum value from array.	○	○	○
Math.Median	Find the median value from an array.	○	○	○
Math.Mode	Find the most frequent value from an array.	○	○	○
Math.Random	Find a random number.	×	○	×
Math.Log	Calculate the natural logarithm.	○	○	○
Math.Log10	Calculates the base 10 logarithm.	○	○	○
Math.Pow	Calculates the power of x to the y power.	○	○	○
Math.Sqrt	Find the square root.	○	○	○
Math.Nthroots	Find the power root.	○	○	○
Math.AddingUp	Calculate the integrated value.	○	○	○
Math.StDev	Calculate the standard deviation.	○	○	○
Math.Correl	Calculate the correlation coefficient.	○	○	○
Math.LineSt	Calculate the slope and offset of the straight line obtained by linear regression analysis (least squares method).	○	○	○
Math.Sin	Ask for an autograph.	○	○	○
Math.Cos	Find the cosine.	○	○	○
Math.Tan	Find the tangent.	○	○	○
Math.Asin	Find the arcsine.	○	○	○
Math.Acos	Calculates the arccosine.	○	○	○
Math.Atan	Find the arctangent.	○	○	○
Math.Exp	Find the exponent.	○	○	○
Math.LinearTrans (Math.LT)	Perform engineering value conversion.	○	○	○
Math.PowerFactorTrans (Math.PT)	Performs power factor conversion.	○	○	○
Math.Summary	Calculates aggregate values (total, average, maximum, minimum).	○	○	○
Math.Round	Move decimal point and truncate.	○	○	○