neoEdge
Execute VisualNEO Win actions when using neoEdge Web Browser to run your app.
neoEdge allows you to call VisualNEO Win commands from VisualNEO Web desktop applications.
This plugin has it's own forum section:
https://visualneo.com/forum/forum/neoedge-related-topics/
_Exec
Purpose: |
Execute VisualNEO Win commands when using neoEdge to run your app. |
Category: |
neoEdge |
Syntax: |
_Exec theCode
theCode VisualNEO Win script code |
_Run
Purpose: |
Execute an external Windows application, DOS Command, etc. |
Category: |
neoEdge |
Syntax: |
_Run "command" "parameters" runonce minimized hidden "variable"
command Command. (File name and location of the application to be launched) parameters Parameters (optional items to be passed to the application) runonce Do not run more than one copy of the app at a time minimized Run app minimized? hidden Run app hidden? variable Variable to store application's unique id number (optional) |
_RunInRectangle
Purpose: |
Execute an external Windows application inside a Rectangle object. The application's window will be sized and/or clipped to fit within the bounds of the specified Rectangle object. This may not work with some types of applications. neoEdge includes 10 predefined not visible Rectangles: Rectangle1...Rectangle10 |
Category: |
neoEdge |
Syntax: |
_RunInRectangle objectName "command" "parameters" hideMenu hideSizeBox "variable"
objectName Choose an existing Rectangle object command File name and location of the application to be launched. parameters Optional items to be passed to the application hideMenu Hide menu? hideSizeBox Hide size box? variable Variable to store application's unique id number (optional) |
_CloseApp
Purpose: |
Close a running application program. |
Category: |
neoEdge |
Syntax: |
_CloseApp "theApp" theMode
theApp File name of a running program or an app ID variable returned by _Run theMode Options |
_SetVar
Purpose: |
Assign a value to a VisualNEO Win variable |
Category: |
neoEdge |
Syntax: |
_SetVar "winvar" "theValue"
winvar VisualNEO Win variable name {{myVar}} theValue Value to store in the variable |
_GetVar
Purpose: |
Get the value from a VisualNEO Win variable into a VisualNEO Web variable. |
Category: |
neoEdge |
Syntax: |
_GetVar "winvar" webvar subroutine
winvar VisualNEO Win variable name {{myVar}} webvar VisualNEO Web variable name subroutine Subroutine to execute once the value is asigned (optional) |
_AlertBox
Purpose: |
Display a Windows style dialog box containing a title, message and an OK button. |
Category: |
neoEdge |
Syntax: |
_AlertBox "thetitle" "message"
thetitle Title message Message |
_MessageBox
Purpose: |
Display a Windows style dialog box containing a message and a custom set of buttons. |
Category: |
neoEdge |
Syntax: |
_MessageBox "thetitle" "message" "buttons" "variable"
thetitle Dialog box title. message Dialog box message. Line breaks can be entered using the pipe character buttons Captions of the custom buttons separated by the pipe character variable Variable name (with no brackets) to store the number of the selected button |
_InputBox
Purpose: |
Display a simple input dialog box and request that the user enter a single line of text. |
Category: |
neoEdge |
Syntax: |
_InputBox "thetitle" "message" "variable"
thetitle Dialog box title. message Dialog box message. Line breaks can be entered using the pipe character variable VisualNEO Win variable {{myVar}} to store text entered by the user. |
_Balloon
Purpose: |
Display a comic book-style speech balloon containing a short message. |
Category: |
neoEdge |
Syntax: |
_Balloon "message" "left" "top" "delay"
message The message you want to appear in the balloon. left Balloon’s left corner coordinate. -1 for mouse position. top Balloon’s top corner coordinate. -1 for mouse position. delay Milliseconds to display the balloon or 0 (zero) to keypress or click |
_StickyNote
Purpose: |
Display a yellow sticky note with a custom message. |
Category: |
neoEdge |
Syntax: |
_StickyNote "left" "top" "message" "delay"
left Sticky note’s left coordinate. -1 to center top Sticky note’s top coordinate. -1 to center message Message for the sticky note. Pipe character for new line delay Milliseconds to display or 0 (zero) until click or keypress |
_PopUpImage
Purpose: |
Display an image file with an optional special effect. |
Category: |
neoEdge |
Syntax: |
_PopUpImage "left" "top" "fileName" "delay" "speed" "effect
left Image left coordinate. -1 to center top Image top coordinate. -1 to center fileName The name of the image file to display. delay Milliseconds to display or 0 (zero) until click or keypress speed The effect’s speed (0 = fastest, 10 = slowest). "effect Effect" |
_FolderBox
Purpose: |
Display a Windows Folder Selector and allow the reader to make a selection. The selected folder is stored in a VisualNEO Win variable. |
Category: |
neoEdge |
Syntax: |
_FolderBox "thetitle" "variable"
thetitle The dialog box title. variable VisualNEO Win variable (no brackets) to store the result |
_FileSaveBox
Purpose: |
Allow the user to specify a file name using a standard Windows File Save dialog box. |
Category: |
neoEdge |
Syntax: |
_FileSaveBox "thetitle" "filemask" "initialdirectory" "variable"
thetitle The dialog box title. filemask A file mask (*.txt or *.*) initialdirectory Initial directory variable VisualNEO Win variable (no brackets) to store the result |
_FileOpenBox
Purpose: |
Allow the user to select a file name using a standard Windows File Open dialog box. |
Category: |
neoEdge |
Syntax: |
_FileOpenBox "thetitle" "filemask" "initialpath" "variable" "theoptions"
thetitle The dialog box title. filemask A file mask (*.txt or *.*) initialpath Folder to display when the File Open dialog box first opens. variable Variable name {{myVar}} to store the result theoptions Leave empty to select single file or Multiple for more |
_FileCopy
Purpose: |
Copy an external file. |
Category: |
neoEdge |
Syntax: |
_FileCopy "sourceFile" "destination"
sourceFile The name of an existing external file on the user’s computer. destination Drive and folder where the file is to be copied |
_FileErase
Purpose: |
Erase an external file. |
Category: |
neoEdge |
Syntax: |
_FileErase "fileName"
fileName The name of an existing external file. |
_FileExists
Purpose: |
Determine if an external file exists. |
Category: |
neoEdge |
Syntax: |
_FileExists "fileName" "variable"
fileName The name of the file (including drive and path) to check. variable Variable to store result {{myVar}} (Can be “True” or “False”) |
_FileSize
Purpose: |
Get the size (in bytes) of an external file. If the file does not exist, the variable will be cleared and an error message displayed. |
Category: |
neoEdge |
Syntax: |
_FileSize "fileName" "variable"
fileName The name of the file (including drive and path) to check. variable VisualNEO Win variable to store the file's size {{myVar}} |
_FolderExists
Purpose: |
Determine if an external folder exists. |
Category: |
neoEdge |
Syntax: |
_FolderExists "folder" "variable"
folder The name of the folder to check. variable Variable to store result {{myVar}}.(Can be “True” or “False”) |
_CreateFolder
Purpose: |
Create a new folder. |
Category: |
neoEdge |
Syntax: |
_CreateFolder "folder"
folder The path and name of the new folder. |
_RemoveFolder
Purpose: |
Remove an existing empty folder from the computer’s hard drive. |
Category: |
neoEdge |
Syntax: |
_RemoveFolder "folder"
folder The name of the folder to remove. |
_FileList
Purpose: |
Generate a list of files and/or folders found in the specified path. |
Category: |
neoEdge |
Syntax: |
_FileList "fileMask" theFiles theFolders noExt "variable"
fileMask Path and file name mask to search. Mask can include wildcard characters. theFiles Include files in the list? theFolders Include folders in the list? noExt Remove extensions from file names before adding them to the list? variable Variable to store the list {{myVar}}. Files will be separated by carriage returns. |
_FileRead
Purpose: |
Read data from an external text file. |
Category: |
neoEdge |
Syntax: |
_FileRead "fileName" ""lineNumber" "variable"
fileName The name of an existing external file. "lineNumber Number of the line in the file to read. Write ""All” to read the entire file at once." variable VisualNEO Win variable to store result: {{myVar}} |
_FileWrite
Purpose: |
Write data to an external text file. |
Category: |
neoEdge |
Syntax: |
_FileWrite "fileName" ""lineNumber" "theData"
fileName The name of an existing external file "lineNumber Number of the line to write to, “Append” (end of file) or ""All"" (replace)" theData The data to be written to the file |
_FileInsLine
Purpose: |
Insert a blank line into an external text file. The external file must be in plain text/ASCII format. All lines from this point forward will be moved down to make room. The first line in the file is 1, the second is 2 and so on. |
Category: |
neoEdge |
Syntax: |
_FileInsLine "fileName" "lineNumber"
fileName The name of an existing external file. lineNumber number of the line in the file where the new line should be inserted |
_DelLine
Purpose: |
Delete a specific line from an external text file. The external file must be in plain text/ASCII format. |
Category: |
neoEdge |
Syntax: |
_DelLine "fileName" "lineNumber"
fileName The name of an existing external file. lineNumber The number of the line in the file to delete. First = 1 |
_FileLen
Purpose: |
Count the number of lines contained in an external text file. |
Category: |
neoEdge |
Syntax: |
_FileLen "fileName" "variable"
fileName The name of an existing external file. variable The name of a variable to store the line count. |
_FileToVar
Purpose: |
Read the contants of a file into a VisualNEO Win variable |
Category: |
neoEdge |
Syntax: |
_FileToVar "thefilename" "variable"
thefilename File name (The name of an existing external file) variable VisualNEO Win variable {{myVar}} to store the content. |
_ExtractFilePath
Purpose: |
Extract the drive and folder portion of a file name. If the file doesn’t have a path, the variable will be empty. |
Category: |
neoEdge |
Syntax: |
_ExtractFilePath "thefilename" "variable"
thefilename The name of a file. variable VisualNEO Win variable {{myVar}} to store the result |
_ExtractFileName
Purpose: |
Extract the name and extension portion of a file name and store the result in a variable. |
Category: |
neoEdge |
Syntax: |
_ExtractFileName "fileName" "variable"
fileName The name of a file. variable VisualNEO Win variable {{myVar}} to store the result |
_ExtractFileExt
Purpose: |
Extract the extension portion of a file name. |
Category: |
neoEdge |
Syntax: |
_ExtractFileExt "fileName" "variable"
fileName The name of a file. variable VisualNEO Win variable {{myVar}} to store the result |
_ExtractFileDrive
Purpose: |
Extract the drive portion of a file name and store the result in a variable. |
Category: |
neoEdge |
Syntax: |
_ExtractFileDrive "fileName" "variable"
fileName A complete file name including drive and path. variable VisualNEO Win variable {{myVar}} to store the result |
_ChangeFileExt
Purpose: |
Change a file name's extension and store the result in a variable. |
Category: |
neoEdge |
Syntax: |
_ChangeFileExt "fileName" "extension" "variable"
fileName A file name extension The new file extension including a period. For example: “.txt” variable VisualNEO Win variable {{myVar}} to store the modified file name |
_RegistryRead
Purpose: |
Read a value from the Windows System Registry database. The Registry contains information about the hardware and software installed on the computer. |
Category: |
neoEdge |
Syntax: |
_RegistryRead "theKey" "theSection" "variable"
theKey The Registry key that contains the data you want to read. theSection The Registry section that contains the actual value to read. variable VisualNEO Win variable {{myVar}} to store the result |
_RegistryWrite
Purpose: |
Write a value to the Windows System Registry database. The Registry contains information about the hardware and software installed on the computer. WARNING: Exercise caution when modifying the Registry. If there is an error in the Registry, your computer (or your user’s computer) may become nonfunctional. |
Category: |
neoEdge |
Syntax: |
_RegistryWrite "theKey" "theSection" "theValue"
theKey The Registry key that contains the section you want to modify theSection The Registry section to modify. theValue The data to write to the Registry. |
_StrIns
Purpose: |
Insert characters into a string. |
Category: |
neoEdge |
Syntax: |
_StrIns "sourceStr" "destinationStr" "insertPosition" "variable"
sourceStr The characters to be inserted. destinationStr The destination string. insertPosition The position in dest string where the characters will be inserted. variable VisualNEO Win variable {{myVar}} to store the modified string. |
_StrDel
Purpose: |
Delete characters from a string. |
Category: |
neoEdge |
Syntax: |
_StrDel "sourceStr" "startPosition" "theLength" "variable"
sourceStr The original string containing the characters to delete. startPosition The position of the first character to delete. theLength The number of characters to delete. variable VisualNEO Win variable {{myVar}} to store the modified string |
_StrLen
Purpose: |
Calculate the length of a string. |
Category: |
neoEdge |
Syntax: |
_StrLen "theStr" "variable"
theStr The string to examine. variable VisualNEO Win variable {{myVar}} to store the string’s length. |
_SubStr
Purpose: |
Copy a portion of a string. |
Category: |
neoEdge |
Syntax: |
_SubStr "sourceStr" "startPosition" "theLength" "variable"
sourceStr The original string containing the characters to copy. startPosition The position of the first character to copy. theLength The number of characters to copy. variable VisualNEO Win variable {{myVar}} to store the copied text. |
_SearchStr
Purpose: |
Search for characters within a text string. The variable will contain 0 (zero) if the characters are not present in the string. |
Category: |
neoEdge |
Syntax: |
_SearchStr "searchStr" "theStr" "variable" theOptions
searchStr The characters to find. theStr The text string to search. variable VisualNEO Win variable {{myVar}} to store position of found characters theOptions Case sensitive? |
_StrUpper
Purpose: |
Convert the contents of a string to upper case. Numbers and punctuation within the string are not affected. |
Category: |
neoEdge |
Syntax: |
_StrUpper "theStr" "variable"
theStr The string to convert. variable VisualNEO Win variable {{myVar}} to store the modified string. |
_StrLower
Purpose: |
Convert the contents of a string to lower case. Numbers and punctuation within the string are not affected. |
Category: |
neoEdge |
Syntax: |
_StrLower "theStr" "variable"
theStr The string to convert. variable VisualNEO Win variable {{myVar}} to store the modified string. |
_StrReplace
Purpose: |
Replace all occurrences of a character or substring within a string. |
Category: |
neoEdge |
Syntax: |
_StrReplace "thestring" "oldchars" "newchars" "variable" theoptions
thestring The original string. oldchars The characters to replace. newchars The replacement characters. variable VisualNEO Win variable {{myVar}} to store the modified string. theoptions CaseSensitive? |
_StrParse
Purpose: |
Separate a string into multiple parts using a delimiter character. |
Category: |
neoEdge |
Syntax: |
_StrParse "theStr" "delimiter" "variable" "countVariable"
theStr The string containing the information to parse. delimiter The character (or characters) used to separate the elements of the string. variable VisualNEO Win variable {{myVar}} to store the parsed elements. countVariable VisualNEO Win variable {{myVar}} to store the number of elements. |
_PopulateStr
Purpose: |
Populate variables contained within a string. VisualNEO Win populates most strings automatically. The exception being strings that come from an external source such as a file loaded with the _FileRead or _FileToVar actions. After reading, if the file contained VisualNEO Win style variables, you can use PopulateStr to replace all of the variables in the string with the contents of those variables. |
Category: |
neoEdge |
Syntax: |
_PopulateStr "theStr" "variable"
theStr The source string containing variables to populate. variable VisualNEO Win variable {{myVar}} to store the modified string. |
_PlayTone
Category: |
neoEdge |
Syntax: |
_PlayTone "frecuency"
frecuency Frecuency (ie: 440) |
_SaveVariables
Purpose: |
Save the contents of all existing VisualNEO Win variables to a file. Use this Action to save an App's entire complement of variables at once. Since variables reside in memory and are cleared when a publication closes, you can use _SaveVariables and _LoadVariables to remember publication settings between sessions. |
Category: |
neoEdge |
Syntax: |
_SaveVariables "fileName"
fileName The name of the file to store the variable data. |
_LoadVariables
Purpose: |
Load VisualNEO Win variables from a file previously created with _SaveVariables. Use this Action to load an entire group of variables at once. Since variables reside in memory and are cleared when a publication closes, you can use _SaveVariables and _LoadVariables to remember variables between sessions. |
Category: |
neoEdge |
Syntax: |
_LoadVariables "fileName"
fileName The name of an external file containing the variables to be loaded. |
_ClearVariables
Purpose: |
Clear VisualNEO Win variables from memory. |
Category: |
neoEdge |
Syntax: |
_ClearVariables "variables"
variables Comma separated list of variables to be cleared. {{var1}},{{var2}},{{var3}} |
_DeleteArray
Purpose: |
Delete a VisualNEO Win array of variables |
Category: |
neoEdge |
Syntax: |
_DeleteArray "arrayName" "arraySize"
arrayName The name of the array variable to delete {{myArray}} arraySize The number of elements to delete or “All” to delete the entire array. |
_CheckInternetConnection
Purpose: |
Determine if this computer is connected to the Internet. |
Category: |
neoEdge |
Syntax: |
_CheckInternetConnection ""variable"
"variable Variable {{varName}} to store connection status: “True"" or “False”." |
_InternetLink
Purpose: |
Launch the computer’s default Internet browser, and navigate to the specified web site URL. |
Category: |
neoEdge |
Syntax: |
_InternetLink "variable"
variable The address of a web site or local file to pass to the browser. |
_DownloadFile
Purpose: |
Download a file from the Internet. |
Category: |
neoEdge |
Syntax: |
_DownloadFile "sourceUrl" "destination" theOptions
sourceUrl The name and location of the file to download. destination Path and name where the downloaded file is to be saved. theOptions Wait or allow to respond to other input during the download |
_InternetFileExists
Purpose: |
Determine if a remote file exists on an Internet server. |
Category: |
neoEdge |
Syntax: |
_InternetFileExists "sourceUrl" "variable" theOptions
sourceUrl The name and location of the file to check. variable Variable to store the result of the search {{myVar}} (True or False) theOptions Wait or allow to respond to other input during the download |
_InternetFileSize
Purpose: |
Obtain the size (in bytes) of a remote file located on an Internet server. |
Category: |
neoEdge |
Syntax: |
_InternetFileSize "sourceUrl" "variable" theOptions
sourceUrl The name and location of the remote file to examine. variable Variable to store the file’s size. {{myVar}} theOptions Wait or allow to respond to other input during the download |
_InternetGet
Purpose: |
Request information from an Internet server. Similar to _DownloadFile except that the returned content will be stored in a variable. This should only be used for content that is compatible with VisualNEO Win variables. |
Category: |
neoEdge |
Syntax: |
_InternetGet "sourceUrl" "variable" theOptions
sourceUrl The name and location of the file, content, etc. to download. variable variable to store the data returned from the server. {{myVar}} theOptions Wait or allow to respond to other input during the download |
_InternetPost
Purpose: |
Send an HTTP command and data to an Internet server. The response from the server will be stored in the supplied variable. |
Category: |
neoEdge |
Syntax: |
_InternetPost "sourceUrl" "theData" "variable" theOptions
sourceUrl The url that will receive the post command. theData Additional data (if any) to send to the server. variable Variable to store the server’s response. {{myVar}} theOptions Wait or allow to respond to other input during the download |
_IsAppRunning
Purpose: |
Determine if a specific application is running. |
Category: |
neoEdge |
Syntax: |
_IsAppRunning "theApp" "variable"
theApp File name of an executable program or an app ID variable returned by _Run variable Variable to store the results. {{myVar}} (True or False) |
_SendKeys
Purpose: |
Send keystrokes to another Windows application. This Action allows you to control another application by simulating keys being typed on the keyboard. If the application is not already loaded, then SendKeys will launch it prior to sending any keystrokes. Keystrokes may include text and any of the special key codes listed below: {BS} {F2} {F7} {F12} {Left} {Del} {Tab} {F3} {F8} {Home} {Right} {Enter} {F4} {F9} {End} {PgUp} {Esc} {F5} {F10} {Up} {PgDn} {F1} {F6} {F11} {Down} {Ins} You can also specify the state (up/down) of the Shift, Control and Alt keys to access virtually the entire range of key combinations. Key codes for these keys are: {ShiftDn} {ShiftUp} {CtrlDn} {CtrlUp} {AltDn} {AltUp} These keys must always be used in pairs. For example, if you use {ShiftDn} you must remember to follow it with a {ShiftUp} code, otherwise your keyboard will behave as if the Shift key is stuck in the down position. |
Category: |
neoEdge |
Syntax: |
_SendKeys "theApp" "keyStrokes"
theApp File name of an executable program or an app ID variable returned by _Run keyStrokes Keystrokes may include text and any of the special key codes |
_ShowObject
Purpose: |
Show a hidden object with an optional animated effect. |
Category: |
neoEdge |
Syntax: |
_ShowObject "objName" "effect "speed"
objName Name of an existing VisualNEO Win object. "effect Effect" speed The effect’s speed (0 = fastest, 10 = slowest) |
_HideObject
Purpose: |
Hide an object with an optional animated effect. |
Category: |
neoEdge |
Syntax: |
_HideObject "objName" "effect "speed"
objName Name of an existing VisualNEO Win object. "effect Effect" speed The effect’s speed (0 = fastest, 10 = slowest) |
_EnableObject
Purpose: |
Enable an object. An enabled object can respond to mouse and keyboard events. Use in conjunction with _DisableObject. |
Category: |
neoEdge |
Syntax: |
_EnableObject "objName"
objName The name of an existing VisualNEO Win object. |
_DisableObject
Purpose: |
Disable an object. Disabled objects ignore all mouse and keyboard events. Disabled objects appear shaded indicating to readers that they are not available for use. |
Category: |
neoEdge |
Syntax: |
_DisableObject "objName"
objName The name of an existing VisualNEO Win object. |
_GetObjectInfo
Purpose: |
Obtain information about a VisualNEO Win object such as its current size, position, visible state, etc. This is useful if you have changed the state of an object and you wish to determine its current condition. If the info type is Visible or Enabled, the variable will contain either “True” or “False”. Left, Top, Width, Height, CursorPosition, ImageWidth, ImageHeight and MediaLength return numeric values. FileName, SelectedText and Caption return text. Not all objects will respond to every type of information request. For example, FileName only works for objects that display files (Picture, Article, etc.). SelectedText can be used to copy highlighted from Text Entry or Article objects. CursorPosition returns the position of the cursor for Text Entry objects only. ImageWidth and ImageHeight only work with Picture objects. MediaLength is limited to Media Player |
Category: |
neoEdge |
Syntax: |
_GetObjectInfo "objName" infoType "variable"
objName The name of an existing VisualNEO Win object. infoType Info type variable Variable to store the requested information {{myVar}} |
_MoveObject
Purpose: |
Change a VisualNEO Win object’s position on the screen. |
Category: |
neoEdge |
Syntax: |
_MoveObject "objName" "posx" "posy"
objName The name of an existing VisualNEO Win object. posx New left coordinate posy New top coordinate |
_SizeObject
Purpose: |
Change the width and height of an object. |
Category: |
neoEdge |
Syntax: |
_SizeObject "objName" "theWidth" "theHeight"
objName The name of an existing VisualNEO Win object. theWidth Object's new width theHeight Object's new height |
_ObjectToFront
Purpose: |
Move an object to the foreground in front of all other objects on the page. |
Category: |
neoEdge |
Syntax: |
_ObjectToFront "objName"
objName Name of an existing VisualNEO Win object. |
_ObjectToBack
Purpose: |
Move an object to the background behind all other objects on the page. |
Category: |
neoEdge |
Syntax: |
_ObjectToBack "objName"
objName Name of an existing VisualNEO Win object. |
_SetObjectFill
Purpose: |
Set an object's fill color and style. |
Category: |
neoEdge |
Syntax: |
_SetObjectFill "objName" "fillColor" fillStyle
objName Name of an existing VisualNEO Win object. fillColor Fill color (ie: 248,192,160) fillStyle Fill style |