Android Tutorial [B4X] Comment Links

Code comments can include clickable links. The following schemes are supported:

http(s):// - Link will be opened with the browser.
Example:

Dim key As String = OrderedMap.Keys.Get(0) 'based on https://www.b4x.com/android/forum/threads/b4x-b4xorderedmap-get-first-item-nth-item-and-last-item.118642/

file:// - Link will be opened with the default program.

'see the presentation: file://C:\Users\H\Documents\Presentation+With+Spaces.pptx

ide:// - Link will be handled by the IDE. There are currently two types of methods:
goto:
Clicking on link will move the cursor to the specified target.

'called from: ide://goto?Module=B4XMainPage&Sub=Button1_Click

Module is optional, the current module is set by default.
Line can be used instead of Sub to jump to a specific line.

run:
Runs an external program. It can be a batch file, a B4J jar file (UI or non-UI) or an executable.
You can pass arguments with the Args parameter, which can be used multiple times.
For example the B4XPages templates includes this line:

'Ctrl + click to export as zip: ide://run?File=%B4X%\Zipper.jar&Args=Project.zip

It calls a B4J program from the internal installation folder named Zipper.jar. It is similar to the built-in 'export as zip' feature but works with cross platform projects.
Note that the external program working directory will be the current project Objects folder.

Notes

• Spaces should be replaced with +.
• The parameters values are url decoded.
• The ide://run method supports these additional arguments:
  • FilesSync=True - Causes the IDE to sync the Files folder after operation completes.
  • CleanProject=True - Causes the IDE to clean the project after operation completes.
  • VMArgs - Similar to Args but added as a JVM argument.
    You can add: VMArgs=-DZeroSharedFiles%3DTrue to a zipper call to delete the content of the platform specific copies of shared files (the content will be added back when the program runs, because of the custom build action).
• The parameter values can include the following case sensitive aliases:
  • %B4X% - installation folder.
  • %PROJECT% - project folder (location of the project .B4? file).
  • %PROJECT_NAME% - project name.
  • %JAVABIN% - configured java bin folder (not available in beta #1)
  • %ADDITIONAL% - Platform specific additional libraries folder.
  • Any other environment variable.

 

[IdasI4A]

How can I put the following route?

    '  ide://run?file="C:\Program+Files+(x86)\Microsoft+Visual+Studio\VB98\VB6.EXE

The link only goes as far as )
ide://run?file="C:\Program+Files+(x86

Thanks

 

[Erel]

You don't need the quotes. Change the ')' with %29

 

[Erel]

Open a folder with explorer:

'open project objects folder: ide://run?File=%WINDIR%\explorer.exe&Args=%PROJECT%\Objects

 

[Erel]

B4A & B4J: Build without running, based on the command line builder:

'click to build: ide://run?File=%B4X%\B4ABuilder.exe&Args=-Task%3DBuild&Args=-BaseFolder%3D..

You can add more parameters. Note that you need to change '=' with %3D in the parameters (if you add more parameters).
Change B4ABuilder to B4JBuilder in B4J.

 

[Erel]

Open Github Desktop:

'github desktop ide://run?file=%WINDIR%\System32\cmd.exe&Args=/c&Args=github&Args=..\..\

The repository path matches a B4XPages project. Change to ..\ if not using B4XPages.

Tip:
gitignore:

**/Objects
**/AutoBackups
*.meta

 

[Erel]

Add to B4XMainPage in B4XPages project to open the project in the other tools:

'B4A ide://run?file=%WINDIR%\System32\cmd.exe&Args=/c&Args=start&Args=..\..\B4A\ProjectName.b4a
'B4i ide://run?file=%WINDIR%\System32\cmd.exe&Args=/c&Args=start&Args=..\..\B4i\ProjectName.b4i
'B4J ide://run?file=%WINDIR%\System32\cmd.exe&Args=/c&Args=start&Args=..\..\B4J\ProjectName.b4j

Change ProjectName with your project name.

 

[Erel]

The file:// scheme doesn't support the special variables that are supported by the more sophisticated ide:// scheme.

When needed you can use the ide:// scheme to open local files with:

'open the b4xlib manifest file with notepad++ ide://run?file=%COMSPEC%&args=/c&args=%PROJECT%\manifest.txt

(%COMSPEC% = path to cmd.exe, same as %WINDIR%\System32\cmd.exe)