-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAppStudio_Project_File_Format.html
More file actions
1618 lines (1550 loc) · 61 KB
/
Copy pathAppStudio_Project_File_Format.html
File metadata and controls
1618 lines (1550 loc) · 61 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html class="client-nojs" lang="en" dir="ltr">
<!-- Mirrored from wiki.appstudio.dev/AppStudio_Project_File_Format by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 10 Mar 2026 20:08:57 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=UTF-8" /><!-- /Added by HTTrack -->
<head>
<meta charset="UTF-8">
<title>AppStudio Project File Format - NSB App Studio</title>
<script>(function(){var className="client-js";var cookie=document.cookie.match(/(?:^|; )nsbasic_mediawiki1348787612mwclientpreferences=([^;]+)/);if(cookie){cookie[1].split('%2C').forEach(function(pref){className=className.replace(new RegExp('(^| )'+pref.replace(/-clientpref-\w+$|[^\w-]+/g,'')+'-clientpref-\\w+( |$)'),'$1'+pref+'$2');});}document.documentElement.className=className;}());RLCONF={"wgBreakFrames":false,"wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy","wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgRequestId":"aaYE1ybyCrIXwED1IPpXEwAAABE","wgCanonicalNamespace":"","wgCanonicalSpecialPageName":false,"wgNamespaceNumber":0,"wgPageName":"AppStudio_Project_File_Format","wgTitle":"AppStudio Project File Format","wgCurRevisionId":11744,"wgRevisionId":11744,"wgArticleId":1439,"wgIsArticle":true,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":[],"wgPageViewLanguage":"en","wgPageContentLanguage":"en","wgPageContentModel":"wikitext","wgRelevantPageName":"AppStudio_Project_File_Format","wgRelevantArticleId":1439,"wgIsProbablyEditable":false,"wgRelevantPageIsProbablyEditable":false,"wgRestrictionEdit":[],"wgRestrictionMove":[]};
RLSTATE={"site.styles":"ready","user.styles":"ready","user":"ready","user.options":"loading","skins.vector.styles.legacy":"ready"};RLPAGEMODULES=["site","mediawiki.page.ready","mediawiki.toc","skins.vector.legacy.js"];</script>
<script>(RLQ=window.RLQ||[]).push(function(){mw.loader.impl(function(){return["user.options@12s5i",function($,jQuery,require,module){mw.user.tokens.set({"patrolToken":"+\\","watchToken":"+\\","csrfToken":"+\\"});
}];});});</script>
<link rel="stylesheet" href="https://wiki.appstudio.dev/load.php?lang=en&modules=skins.vector.styles.legacy&only=styles&skin=vector">
<script async="" src="https://wiki.appstudio.dev/load.php?lang=en&modules=startup&only=scripts&raw=1&skin=vector"></script>
<meta name="ResourceLoaderDynamicStyles" content="">
<link rel="stylesheet" href="https://wiki.appstudio.dev/load.php?lang=en&modules=site.styles&only=styles&skin=vector">
<meta name="generator" content="MediaWiki 1.45.0">
<meta name="robots" content="max-image-preview:standard">
<meta name="format-detection" content="telephone=no">
<meta name="viewport" content="width=1120">
<link rel="search" type="application/opensearchdescription+xml" href="https://wiki.appstudio.dev/rest.php/v1/search" title="NSB App Studio (en)">
<link rel="EditURI" type="application/rsd+xml" href="https://wiki.appstudio.dev/api.php?action=rsd">
<link rel="alternate" type="application/atom+xml" title="NSB App Studio Atom feed" href="https://wiki.appstudio.dev/index.php?title=Special:RecentChanges&feed=atom">
</head>
<body class="skin-vector-legacy mediawiki ltr sitedir-ltr mw-hide-empty-elt ns-0 ns-subject page-AppStudio_Project_File_Format rootpage-AppStudio_Project_File_Format skin-vector action-view"><div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body" role="main">
<a id="top"></a>
<div id="siteNotice"></div>
<div class="mw-indicators">
</div>
<h1 id="firstHeading" class="firstHeading mw-first-heading"><span class="mw-page-title-main">AppStudio Project File Format</span></h1>
<div id="bodyContent" class="vector-body">
<div id="siteSub" class="noprint">From NSB App Studio</div>
<div id="contentSub"><div id="mw-content-subtitle"></div></div>
<div id="contentSub2"></div>
<div id="jump-to-nav"></div>
<a class="mw-jump-link" href="#mw-head">Jump to navigation</a>
<a class="mw-jump-link" href="#searchInput">Jump to search</a>
<div id="mw-content-text" class="mw-body-content"><div class="mw-content-ltr mw-parser-output" lang="en" dir="ltr"><div id="toc" class="toc" role="navigation" aria-labelledby="mw-toc-heading"><input type="checkbox" role="button" id="toctogglecheckbox" class="toctogglecheckbox" style="display:none" /><div class="toctitle" lang="en" dir="ltr"><h2 id="mw-toc-heading">Contents</h2><span class="toctogglespan"><label class="toctogglelabel" for="toctogglecheckbox"></label></span></div>
<ul>
<li class="toclevel-1 tocsection-1"><a href="#AppStudio_Project_File_Format"><span class="tocnumber">1</span> <span class="toctext">AppStudio Project File Format</span></a>
<ul>
<li class="toclevel-2 tocsection-2"><a href="#Overview"><span class="tocnumber">1.1</span> <span class="toctext">Overview</span></a></li>
<li class="toclevel-2 tocsection-3"><a href="#Directory_Layout"><span class="tocnumber">1.2</span> <span class="toctext">Directory Layout</span></a></li>
<li class="toclevel-2 tocsection-4"><a href="#The_Project_File_(*.project)"><span class="tocnumber">1.3</span> <span class="toctext">The Project File (*.project)</span></a>
<ul>
<li class="toclevel-3 tocsection-5"><a href="#Top-level_(Project_object)"><span class="tocnumber">1.3.1</span> <span class="toctext">Top-level (Project object)</span></a></li>
<li class="toclevel-3 tocsection-6"><a href="#Page_object_(inside_children)"><span class="tocnumber">1.3.2</span> <span class="toctext">Page object (inside children)</span></a></li>
</ul>
</li>
<li class="toclevel-2 tocsection-7"><a href="#Form_Files"><span class="tocnumber">1.4</span> <span class="toctext">Form Files</span></a>
<ul>
<li class="toclevel-3 tocsection-8"><a href="#Form_object_properties"><span class="tocnumber">1.4.1</span> <span class="toctext">Form object properties</span></a></li>
</ul>
</li>
<li class="toclevel-2 tocsection-9"><a href="#Element_Files"><span class="tocnumber">1.5</span> <span class="toctext">Element Files</span></a>
<ul>
<li class="toclevel-3 tocsection-10"><a href="#Common_properties"><span class="tocnumber">1.5.1</span> <span class="toctext">Common properties</span></a></li>
<li class="toclevel-3 tocsection-11"><a href="#Bootstrap_appearance_properties"><span class="tocnumber">1.5.2</span> <span class="toctext">Bootstrap appearance properties</span></a></li>
<li class="toclevel-3 tocsection-12"><a href="#Popover_properties"><span class="tocnumber">1.5.3</span> <span class="toctext">Popover properties</span></a></li>
<li class="toclevel-3 tocsection-13"><a href="#Badge_properties"><span class="tocnumber">1.5.4</span> <span class="toctext">Badge properties</span></a></li>
<li class="toclevel-3 tocsection-14"><a href="#Common_event_handlers"><span class="tocnumber">1.5.5</span> <span class="toctext">Common event handlers</span></a></li>
<li class="toclevel-3 tocsection-15"><a href="#Selected_control-specific_properties"><span class="tocnumber">1.5.6</span> <span class="toctext">Selected control-specific properties</span></a>
<ul>
<li class="toclevel-4 tocsection-16"><a href="#Button_(Button_bs4)"><span class="tocnumber">1.5.6.1</span> <span class="toctext">Button (Button_bs4)</span></a></li>
<li class="toclevel-4 tocsection-17"><a href="#Text_Area_(Textarea_bs4)"><span class="tocnumber">1.5.6.2</span> <span class="toctext">Text Area (Textarea_bs4)</span></a></li>
</ul>
</li>
</ul>
</li>
<li class="toclevel-2 tocsection-18"><a href="#Code_Files"><span class="tocnumber">1.6</span> <span class="toctext">Code Files</span></a>
<ul>
<li class="toclevel-3 tocsection-19"><a href="#BASIC_code_files_(.bas)"><span class="tocnumber">1.6.1</span> <span class="toctext">BASIC code files (.bas)</span></a></li>
<li class="toclevel-3 tocsection-20"><a href="#JavaScript_code_files_(.js)"><span class="tocnumber">1.6.2</span> <span class="toctext">JavaScript code files (.js)</span></a></li>
<li class="toclevel-3 tocsection-21"><a href="#Inline_script"><span class="tocnumber">1.6.3</span> <span class="toctext">Inline script</span></a></li>
</ul>
</li>
<li class="toclevel-2 tocsection-22"><a href="#The_properties/_Directory"><span class="tocnumber">1.7</span> <span class="toctext">The properties/ Directory</span></a>
<ul>
<li class="toclevel-3 tocsection-23"><a href="#config.xml"><span class="tocnumber">1.7.1</span> <span class="toctext">config.xml</span></a></li>
<li class="toclevel-3 tocsection-24"><a href="#manifest.json"><span class="tocnumber">1.7.2</span> <span class="toctext">manifest.json</span></a></li>
<li class="toclevel-3 tocsection-25"><a href="#package.json"><span class="tocnumber">1.7.3</span> <span class="toctext">package.json</span></a></li>
<li class="toclevel-3 tocsection-26"><a href="#electronMain.js"><span class="tocnumber">1.7.4</span> <span class="toctext">electronMain.js</span></a></li>
<li class="toclevel-3 tocsection-27"><a href="#style.css"><span class="tocnumber">1.7.5</span> <span class="toctext">style.css</span></a></li>
</ul>
</li>
<li class="toclevel-2 tocsection-28"><a href="#External_References"><span class="tocnumber">1.8</span> <span class="toctext">External References</span></a></li>
<li class="toclevel-2 tocsection-29"><a href="#Complete_Example"><span class="tocnumber">1.9</span> <span class="toctext">Complete Example</span></a>
<ul>
<li class="toclevel-3 tocsection-30"><a href="#HelloWorld.project"><span class="tocnumber">1.9.1</span> <span class="toctext">HelloWorld.project</span></a></li>
<li class="toclevel-3 tocsection-31"><a href="#forms/Form1/Form1.json"><span class="tocnumber">1.9.2</span> <span class="toctext">forms/Form1/Form1.json</span></a></li>
<li class="toclevel-3 tocsection-32"><a href="#forms/Form1/Elements/Button1.json"><span class="tocnumber">1.9.3</span> <span class="toctext">forms/Form1/Elements/Button1.json</span></a></li>
<li class="toclevel-3 tocsection-33"><a href="#forms/Form1/Elements/TextArea1.json"><span class="tocnumber">1.9.4</span> <span class="toctext">forms/Form1/Elements/TextArea1.json</span></a></li>
<li class="toclevel-3 tocsection-34"><a href="#forms/Form1/Form1.bas"><span class="tocnumber">1.9.5</span> <span class="toctext">forms/Form1/Form1.bas</span></a></li>
</ul>
</li>
<li class="toclevel-2 tocsection-35"><a href="#See_Also"><span class="tocnumber">1.10</span> <span class="toctext">See Also</span></a></li>
</ul>
</li>
</ul>
</div>
<div class="mw-heading mw-heading1"><h1 id="AppStudio_Project_File_Format">AppStudio Project File Format</h1></div>
<p>This page describes the on-disk format of an AppStudio project. It is intended for developers who want to understand, inspect, or programmatically manipulate project files.
</p>
<div class="mw-heading mw-heading2"><h2 id="Overview">Overview</h2></div>
<p>An AppStudio project is stored as a <b>directory</b> whose name ends with <code>.appstudio</code>. Everything belonging to the project lives inside that directory. The project is made up of plain JSON text files and optional code files, so you can open them in any text editor.
</p>
<div class="mw-heading mw-heading2"><h2 id="Directory_Layout">Directory Layout</h2></div>
<pre>MyApp.appstudio/
├── MyApp.project ← Main project file (JSON)
├── forms/ ← One sub-directory per form
│ ├── Form1/
│ │ ├── Form1.json ← Form definition (JSON)
│ │ ├── Form1.bas ← Form BASIC code (optional)
│ │ ├── Form1.js ← Form JavaScript code (optional)
│ │ └── Elements/
│ │ ├── Button1.json ← Control definition (JSON)
│ │ ├── TextArea1.json
│ │ └── ...
│ ├── Form2/
│ │ └── ...
│ └── ...
├── properties/ ← Build / deployment configuration
│ ├── config.xml ← Apache Cordova / VoltBuilder config
│ ├── manifest.json ← Progressive Web App (PWA) manifest
│ ├── package.json ← Electron build config
│ ├── electronMain.js ← Electron entry-point script
│ └── style.css ← Project-wide CSS (optional)
└── .gitignore
</pre>
<p>The only required file is the <code>.project</code> file. All other files are created automatically as you add forms and controls in the IDE.
</p>
<div class="mw-heading mw-heading2"><h2 id="The_Project_File_(*.project)"><span id="The_Project_File_.28.2A.project.29"></span>The Project File (<code>*.project</code>)</h2></div>
<p>The project file is a JSON file at the root of the <code>.appstudio</code> directory. Its name matches the project name (e.g. <code>MyApp.project</code>).
</p>
<div class="mw-heading mw-heading3"><h3 id="Top-level_(Project_object)"><span id="Top-level_.28Project_object.29"></span>Top-level (Project object)</h3></div>
<table class="wikitable">
<tbody><tr>
<th>Property</th>
<th>Type</th>
<th>Description
</th></tr>
<tr>
<td><code>"!type"</code></td>
<td>String</td>
<td>Always <code>"Project"</code>. Identifies this object as the root project.
</td></tr>
<tr>
<td><code>version</code></td>
<td>Integer</td>
<td>Project file format version. Current value is <code>8</code>.
</td></tr>
<tr>
<td><code>language_version</code></td>
<td>Integer</td>
<td>BASIC language version. Current value is <code>8</code>.
</td></tr>
<tr>
<td><code>id</code></td>
<td>String</td>
<td>Project identifier. Usually the project name without spaces.
</td></tr>
<tr>
<td><code>filename</code></td>
<td>String</td>
<td>Absolute path to the <code>.appstudio</code> directory (set at runtime; empty in the file).
</td></tr>
<tr>
<td><code>libraries</code></td>
<td>Array of String</td>
<td>Libraries included in the project, e.g. <code>["BASIC"]</code>.
</td></tr>
<tr>
<td><code>script</code></td>
<td>String</td>
<td>Project-level code that runs before any form code.
</td></tr>
<tr>
<td><code>children</code></td>
<td>Array</td>
<td>Contains exactly one <a href="#Page_object">Page object</a> (inline, not a file reference).
</td></tr>
<tr>
<td><code>deploy_protocol</code></td>
<td>String</td>
<td>Deployment protocol: <code>"ftp"</code>, <code>"sftp"</code>, or <code>"local"</code>.
</td></tr>
<tr>
<td><code>deploy_server</code></td>
<td>String</td>
<td>FTP/SFTP server hostname.
</td></tr>
<tr>
<td><code>deploy_port</code></td>
<td>String</td>
<td>Server port, default <code>"21"</code>.
</td></tr>
<tr>
<td><code>deploy_userName</code></td>
<td>String</td>
<td>Login username for FTP/SFTP.
</td></tr>
<tr>
<td><code>deploy_password</code></td>
<td>String</td>
<td>Login password (stored in plain text — keep the file private).
</td></tr>
<tr>
<td><code>deploy_path</code></td>
<td>String</td>
<td>Remote path to upload files to.
</td></tr>
<tr>
<td><code>deploy_local</code></td>
<td>Boolean</td>
<td>If <code>true</code>, deploy to a local folder instead of a server.
</td></tr>
<tr>
<td><code>deploy_localPath</code></td>
<td>String</td>
<td>Local folder path used when <code>deploy_local</code> is <code>true</code>.
</td></tr>
<tr>
<td><code>deploy_global</code></td>
<td>Boolean</td>
<td>If <code>true</code>, use global (shared) deployment settings.
</td></tr>
<tr>
<td><code>phonegap_email</code></td>
<td>String</td>
<td>Adobe PhoneGap Build account e-mail (legacy; prefer VoltBuilder).
</td></tr>
<tr>
<td><code>phonegap_password</code></td>
<td>String</td>
<td>Adobe PhoneGap Build password (legacy).
</td></tr>
<tr>
<td><code>phonegap_auth_token</code></td>
<td>String</td>
<td>Adobe PhoneGap Build API token (legacy).
</td></tr>
<tr>
<td><code>cached_js</code></td>
<td>String</td>
<td>Cached compiled JavaScript for the project (managed by the IDE).
</td></tr>
<tr>
<td><code>cached_js_script_hash</code></td>
<td>String</td>
<td>MD5 hash of the source used to generate <code>cached_js</code>.
</td></tr>
<tr>
<td><code>cache_dirty</code></td>
<td>Boolean</td>
<td>When <code>true</code>, the IDE will recompile the project before the next run.
</td></tr>
<tr>
<td><code>expanded_pmp</code></td>
<td>String or null</td>
<td>Remembers which nodes are expanded in the Project Manager panel.
</td></tr></tbody></table>
<div class="mw-heading mw-heading3"><h3 id="Page_object_(inside_children)"><span id="Page_object_.28inside_children.29"></span>Page object (inside <code>children</code>)</h3></div>
<p>A project contains exactly one Page object. It is stored inline in the <code>.project</code> file (not as a separate file).
</p>
<table class="wikitable">
<tbody><tr>
<th>Property</th>
<th>Type</th>
<th>Description
</th></tr>
<tr>
<td><code>"!type"</code></td>
<td>String</td>
<td>Always <code>"Page"</code>.
</td></tr>
<tr>
<td><code>id</code></td>
<td>String</td>
<td>Page / app identifier. Typically the same as the project name.
</td></tr>
<tr>
<td><code>title</code></td>
<td>String</td>
<td>App title shown in the browser tab and home screen.
</td></tr>
<tr>
<td><code>description</code></td>
<td>String</td>
<td>Short description of the app.
</td></tr>
<tr>
<td><code>version</code></td>
<td>String</td>
<td>App version string, e.g. <code>"1.0.0"</code>.
</td></tr>
<tr>
<td><code>copyright</code></td>
<td>String</td>
<td>Copyright notice included in the built app.
</td></tr>
<tr>
<td><code>appPublisher</code></td>
<td>String</td>
<td>Publisher name.
</td></tr>
<tr>
<td><code>language</code></td>
<td>String</td>
<td>Default code language: <code>"BASIC"</code> or <code>"JavaScript"</code>.
</td></tr>
<tr>
<td><code>firstform</code></td>
<td>String</td>
<td><code>id</code> of the form shown when the app starts.
</td></tr>
<tr>
<td><code>defaultformsize</code></td>
<td>String</td>
<td>Design canvas size, e.g. <code>"320x460"</code>.
</td></tr>
<tr>
<td><code>fontFamily</code></td>
<td>String</td>
<td>Default font family, e.g. <code>"helvetica"</code>.
</td></tr>
<tr>
<td><code>icon</code></td>
<td>String</td>
<td>Path to the app icon (192 × 192 px PNG), e.g. <code>"nsb/images/512.png"</code>.
</td></tr>
<tr>
<td><code>iconAndroid</code></td>
<td>String</td>
<td>Path to the Android-specific icon (192 × 192 px PNG).
</td></tr>
<tr>
<td><code>splashscreen</code></td>
<td>String</td>
<td>Path to the splash screen image.
</td></tr>
<tr>
<td><code>BootstrapTheme</code></td>
<td>String</td>
<td>Bootstrap CSS theme name, e.g. <code>"bootstrap"</code>.
</td></tr>
<tr>
<td><code>theme</code></td>
<td>String</td>
<td>jQuery Mobile theme letter, e.g. <code>"a"</code>.
</td></tr>
<tr>
<td><code>style</code></td>
<td>String</td>
<td>Additional CSS applied to the whole app.
</td></tr>
<tr>
<td><code>background</code></td>
<td>String</td>
<td>CSS background colour or value for the page body.
</td></tr>
<tr>
<td><code>backgroundimage</code></td>
<td>String</td>
<td>URL or path to a background image.
</td></tr>
<tr>
<td><code>enableBrowserArrows</code></td>
<td>String (<code>"true"</code>/<code>"false"</code>)</td>
<td>When <code>"true"</code>, the browser Back / Forward buttons navigate between forms.
</td></tr>
<tr>
<td><code>enableNiceLinks</code></td>
<td>String (<code>"true"</code>/<code>"false"</code>)</td>
<td>When <code>"true"</code>, the URL bar reflects the current form name.
</td></tr>
<tr>
<td><code>contentSecurityPolicy</code></td>
<td>String</td>
<td>Value of the <code>Content-Security-Policy</code> meta tag (leave blank for the default policy).
</td></tr>
<tr>
<td><code>manifest</code></td>
<td>String or null</td>
<td>Inline app-cache manifest content (legacy).
</td></tr>
<tr>
<td><code>manifestFile</code></td>
<td>String</td>
<td>Name of the manifest file, e.g. <code>"appcache"</code>.
</td></tr>
<tr>
<td><code>manifestName</code></td>
<td>String</td>
<td>Name attribute of the manifest, e.g. <code>"OfflineApp"</code>.
</td></tr>
<tr>
<td><code>disablePWA</code></td>
<td>String</td>
<td>Set to <code>"true"</code> to suppress the PWA service-worker and manifest.
</td></tr>
<tr>
<td><code>FastClick</code></td>
<td>String (<code>"true"</code>/<code>"false"</code>)</td>
<td>Enables the FastClick library to remove the 300 ms tap delay on mobile.
</td></tr>
<tr>
<td><code>stopOnError</code></td>
<td>String (<code>"true"</code>/<code>"false"</code>)</td>
<td>When <code>"true"</code>, unhandled runtime errors stop the app and display a message.
</td></tr>
<tr>
<td><code>obfuscation</code></td>
<td>String</td>
<td>Set to <code>"true"</code> to obfuscate the compiled JavaScript on build.
</td></tr>
<tr>
<td><code>obfuscatorSettings</code></td>
<td>String (JSON)</td>
<td>JSON string containing javascript-obfuscator options.
</td></tr>
<tr>
<td><code>eslintRules</code></td>
<td>String or null</td>
<td>Custom ESLint rules as a JSON string (JavaScript projects only).
</td></tr>
<tr>
<td><code>useStrict</code></td>
<td>String</td>
<td>Set to <code>"true"</code> to add <code>"use strict"</code> to the generated JavaScript.
</td></tr>
<tr>
<td><code>extraheaders</code></td>
<td>String or null</td>
<td>Raw HTML inserted into the <code><head></code> of the generated page.
</td></tr>
<tr>
<td><code>styleheaders</code></td>
<td>String or null</td>
<td>Additional CSS inserted into the <code><head></code> of the generated page as a <code><style></code> block. When non-empty this content is also stored in the external file <code>properties/style.css</code>.
</td></tr>
<tr>
<td><code>script</code></td>
<td>String or null</td>
<td>Page-level code shared across all forms.
</td></tr>
<tr>
<td><code>voltAppId</code></td>
<td>String</td>
<td>App ID registered on VoltBuilder.
</td></tr>
<tr>
<td><code>voltDomain</code></td>
<td>String</td>
<td>Custom domain used for VoltBuilder builds.
</td></tr>
<tr>
<td><code>phoneGapBuildID</code></td>
<td>String</td>
<td>Adobe PhoneGap Build app ID (legacy).
</td></tr>
<tr>
<td><code>phoneGapVersion</code></td>
<td>String</td>
<td>Target PhoneGap / Cordova version (legacy).
</td></tr>
<tr>
<td><code>phoneGapLanguages</code></td>
<td>String</td>
<td>Comma-separated language codes, e.g. <code>"en"</code>.
</td></tr>
<tr>
<td><code>phoneGapStatusBarColor</code></td>
<td>String</td>
<td>Status bar background colour, e.g. <code>"#000000"</code>.
</td></tr>
<tr>
<td><code>phoneGapStatusBarStyle</code></td>
<td>String</td>
<td>Status bar style: <code>"lightcontent"</code> or <code>"default"</code>.
</td></tr>
<tr>
<td><code>phoneGapStatusBarOverlay</code></td>
<td>String (<code>"true"</code>/<code>"false"</code>)</td>
<td>Whether the status bar overlays the web view.
</td></tr>
<tr>
<td><code>electronDevTools</code></td>
<td>String (<code>"true"</code>/<code>"false"</code>)</td>
<td>Open DevTools automatically when running in Electron.
</td></tr>
<tr>
<td><code>electronMain</code></td>
<td>String or null</td>
<td>Override content of <code>properties/electronMain.js</code>.
</td></tr>
<tr>
<td><code>electronPackage</code></td>
<td>String or null</td>
<td>Override content of <code>properties/package.json</code>.
</td></tr>
<tr>
<td><code>configxml</code></td>
<td>String or null</td>
<td>Override content of <code>properties/config.xml</code>.
</td></tr>
<tr>
<td><code>viewportFit</code></td>
<td>String</td>
<td>Viewport fit value for notched phones, e.g. <code>"cover"</code>.
</td></tr>
<tr>
<td><code>rtl</code></td>
<td>String</td>
<td>Set to <code>"true"</code> to switch the app to right-to-left layout.
</td></tr>
<tr>
<td><code>homescreenTitle</code></td>
<td>String</td>
<td>Short name shown below the icon on the device home screen.
</td></tr>
<tr>
<td><code>browserwarnmsg</code></td>
<td>String</td>
<td>Message shown when the app is opened in an unsupported browser.
</td></tr>
<tr>
<td><code>onresize</code></td>
<td>String</td>
<td>Code called when the browser window is resized.
</td></tr>
<tr>
<td><code>onorientationchange</code></td>
<td>String</td>
<td>Code called when the device orientation changes.
</td></tr>
<tr>
<td><code>onvisibilitychange</code></td>
<td>String</td>
<td>Code called when the page visibility changes.
</td></tr>
<tr>
<td><code>children</code></td>
<td>Array</td>
<td><a href="#External_references">External references</a> to each <a href="#Form_files">form JSON file</a>.
</td></tr></tbody></table>
<div class="mw-heading mw-heading2"><h2 id="Form_Files">Form Files</h2></div>
<p>Each form is stored in its own sub-directory under <code>forms/</code>. The JSON file shares the name of the directory:
</p>
<pre>forms/
└── Form1/
├── Form1.json ← Form definition
├── Form1.bas ← BASIC code for this form (optional)
├── Form1.js ← JavaScript code for this form (optional)
└── Elements/
├── Button1.json
└── TextArea1.json
</pre>
<div class="mw-heading mw-heading3"><h3 id="Form_object_properties">Form object properties</h3></div>
<table class="wikitable">
<tbody><tr>
<th>Property</th>
<th>Type</th>
<th>Description
</th></tr>
<tr>
<td><code>"!type"</code></td>
<td>String</td>
<td>Always <code>"Form"</code>.
</td></tr>
<tr>
<td><code>id</code></td>
<td>String</td>
<td>Unique identifier of this form. Used in code to refer to the form and its controls.
</td></tr>
<tr>
<td><code>width</code></td>
<td>Integer</td>
<td>Form width in pixels at design time.
</td></tr>
<tr>
<td><code>height</code></td>
<td>Integer</td>
<td>Form height in pixels at design time.
</td></tr>
<tr>
<td><code>designWidth</code></td>
<td>Integer</td>
<td>Width of the design canvas (may differ from <code>width</code> when using responsive layout).
</td></tr>
<tr>
<td><code>designHeight</code></td>
<td>Integer</td>
<td>Height of the design canvas.
</td></tr>
<tr>
<td><code>left</code></td>
<td>Integer</td>
<td>Left position offset in pixels.
</td></tr>
<tr>
<td><code>top</code></td>
<td>Integer</td>
<td>Top position offset in pixels.
</td></tr>
<tr>
<td><code>position</code></td>
<td>String</td>
<td>CSS <code>position</code> value, typically <code>"absolute"</code>.
</td></tr>
<tr>
<td><code>language</code></td>
<td>String</td>
<td>Code language for this form: <code>"BASIC"</code> or <code>"JavaScript"</code>.
</td></tr>
<tr>
<td><code>fullScreen</code></td>
<td>String (<code>"true"</code>/<code>"false"</code>)</td>
<td>When <code>"true"</code>, the form fills the entire screen.
</td></tr>
<tr>
<td><code>modal</code></td>
<td>String (<code>"true"</code>/<code>"false"</code>)</td>
<td>When <code>"true"</code>, the form is displayed as a modal dialog.
</td></tr>
<tr>
<td><code>openMode</code></td>
<td>String</td>
<td>Transition used when opening the form (e.g. <code>"none"</code>, <code>"fade"</code>, <code>"slide"</code>).
</td></tr>
<tr>
<td><code>scrolling</code></td>
<td>String (<code>"true"</code>/<code>"false"</code>)</td>
<td>Enables iScroll-based scrolling inside the form.
</td></tr>
<tr>
<td><code>scroll_options</code></td>
<td>String</td>
<td>iScroll options as a comma-separated key:value string.
</td></tr>
<tr>
<td><code>theme</code></td>
<td>String</td>
<td>jQuery Mobile theme letter for this form (overrides the page theme).
</td></tr>
<tr>
<td><code>background</code></td>
<td>String</td>
<td>CSS background colour or value.
</td></tr>
<tr>
<td><code>backgroundimage</code></td>
<td>String</td>
<td>Path or URL to a background image.
</td></tr>
<tr>
<td><code>style</code></td>
<td>String</td>
<td>Additional inline CSS for the form container.
</td></tr>
<tr>
<td><code>class</code></td>
<td>String</td>
<td>Additional CSS class names for the form container.
</td></tr>
<tr>
<td><code>borderColor</code></td>
<td>String</td>
<td>Border colour (design-time only).
</td></tr>
<tr>
<td><code>borderStyle</code></td>
<td>String</td>
<td>Border style (design-time only).
</td></tr>
<tr>
<td><code>borderWidth</code></td>
<td>String</td>
<td>Border width (design-time only).
</td></tr>
<tr>
<td><code>action</code></td>
<td>String</td>
<td>HTML <code>action</code> attribute when the form is rendered as a <code><form></code> element.
</td></tr>
<tr>
<td><code>method</code></td>
<td>String</td>
<td>HTML <code>method</code> attribute (<code>"get"</code> or <code>"post"</code>).
</td></tr>
<tr>
<td><code>onsubmit</code></td>
<td>String</td>
<td>Code called when the form is submitted.
</td></tr>
<tr>
<td><code>onshow</code></td>
<td>String</td>
<td>Code called when the form becomes visible.
</td></tr>
<tr>
<td><code>onhide</code></td>
<td>String</td>
<td>Code called when the form is hidden.
</td></tr>
<tr>
<td><code>onresize</code></td>
<td>String</td>
<td>Code called when the form is resized.
</td></tr>
<tr>
<td><code>onkeypress</code></td>
<td>String</td>
<td>Code called on a key-press event anywhere on the form.
</td></tr>
<tr>
<td><code>setFocusID</code></td>
<td>String</td>
<td><code>id</code> of the control that receives focus when the form opens.
</td></tr>
<tr>
<td><code>parentForm</code></td>
<td>String</td>
<td><code>id</code> of another form that this form is visually nested inside.
</td></tr>
<tr>
<td><code>HTML</code></td>
<td>String or null</td>
<td>Raw HTML injected at the top of the form (advanced use).
</td></tr>
<tr>
<td><code>attributes</code></td>
<td>String</td>
<td>Additional HTML attributes added to the form element.
</td></tr>
<tr>
<td><code>locked</code></td>
<td>Boolean</td>
<td>When <code>true</code>, controls on this form cannot be moved in the designer.
</td></tr>
<tr>
<td><code>script</code></td>
<td>String or null</td>
<td>Form code. <code>null</code> when code is stored in the external <code>.bas</code> or <code>.js</code> file.
</td></tr>
<tr>
<td><code>cached_js</code></td>
<td>String or null</td>
<td>Cached compiled JavaScript (managed by the IDE).
</td></tr>
<tr>
<td><code>cached_js_script_hash</code></td>
<td>String or null</td>
<td>MD5 hash used to detect when recompilation is needed.
</td></tr>
<tr>
<td><code>cache_dirty</code></td>
<td>Boolean</td>
<td><code>true</code> when the cached JavaScript is out of date.
</td></tr>
<tr>
<td><code>children</code></td>
<td>Array</td>
<td><a href="#External_references">External references</a> to each <a href="#Element_files">element JSON file</a>.
</td></tr></tbody></table>
<div class="mw-heading mw-heading2"><h2 id="Element_Files">Element Files</h2></div>
<p>Each control (button, text box, label, etc.) on a form is stored as a separate JSON file in the <code>Elements/</code> sub-directory of the form.
</p>
<div class="mw-heading mw-heading3"><h3 id="Common_properties">Common properties</h3></div>
<p>All controls may share the following properties. Not all properties are used by all elements - they may only have the ones they actually use. They may also have additional properties, which are defined in the Toolbox Files for that control.
</p>
<table class="wikitable">
<tbody><tr>
<th>Property</th>
<th>Type</th>
<th>Description
</th></tr>
<tr>
<td><code>"!type"</code></td>
<td>String</td>
<td>The control type, e.g. <code>"Button_bs4"</code>, <code>"Textarea_bs4"</code>, <code>"Label_bs4"</code>. The suffix <code>_bs4</code> indicates a Bootstrap 4 control.
</td></tr>
<tr>
<td><code>id</code></td>
<td>String</td>
<td>Unique identifier of this control within the form. Used in code to access the control at runtime (e.g. <code>Button1.value</code>).
</td></tr>
<tr>
<td><code>left</code></td>
<td>Integer</td>
<td>Left position in pixels, relative to the form.
</td></tr>
<tr>
<td><code>top</code></td>
<td>Integer</td>
<td>Top position in pixels, relative to the form.
</td></tr>
<tr>
<td><code>width</code></td>
<td>Integer or String</td>
<td>Width in pixels, or <code>"auto"</code>.
</td></tr>
<tr>
<td><code>height</code></td>
<td>Integer or String</td>
<td>Height in pixels, or <code>"auto"</code>.
</td></tr>
<tr>
<td><code>right</code></td>
<td>String</td>
<td>CSS <code>right</code> value, typically <code>"auto"</code>.
</td></tr>
<tr>
<td><code>bottom</code></td>
<td>String</td>
<td>CSS <code>bottom</code> value, typically <code>"auto"</code>.
</td></tr>
<tr>
<td><code>position</code></td>
<td>String</td>
<td>CSS <code>position</code> mode: <code>"absolute"</code>, <code>"relative"</code>, or <code>"static"</code>.
</td></tr>
<tr>
<td><code>hidden</code></td>
<td>String</td>
<td>Set to <code>"true"</code> to hide the control at runtime.
</td></tr>
<tr>
<td><code>disabled</code></td>
<td>String</td>
<td>Set to <code>"true"</code> to disable user interaction.
</td></tr>
<tr>
<td><code>class</code></td>
<td>String</td>
<td>Additional CSS class names.
</td></tr>
<tr>
<td><code>style</code></td>
<td>String</td>
<td>Additional inline CSS styles.
</td></tr>
<tr>
<td><code>display</code></td>
<td>String</td>
<td>CSS <code>display</code> value (overrides the default).
</td></tr>
<tr>
<td><code>color</code></td>
<td>String</td>
<td>Foreground / text colour (CSS value).
</td></tr>
<tr>
<td><code>backgroundColor</code></td>
<td>String</td>
<td>Background colour (CSS value).
</td></tr>
<tr>
<td><code>fontFamily</code></td>
<td>String</td>
<td>Font family (CSS value).
</td></tr>
<tr>
<td><code>fontSize</code></td>
<td>String</td>
<td>Font size (CSS value, e.g. <code>"14px"</code>).
</td></tr>
<tr>
<td><code>fontStyle</code></td>
<td>String</td>
<td>Font style: <code>"italic"</code>, <code>"normal"</code>, etc.
</td></tr>
<tr>
<td><code>fontWeight</code></td>
<td>String</td>
<td>Font weight: <code>"bold"</code>, <code>"normal"</code>, etc.
</td></tr>
<tr>
<td><code>mAll</code>, <code>mTop</code>, <code>mBottom</code>, <code>mLeft</code>, <code>mRight</code></td>
<td>String</td>
<td>CSS margin shorthand and individual sides.
</td></tr>
<tr>
<td><code>pAll</code>, <code>pTop</code>, <code>pBottom</code>, <code>pLeft</code>, <code>pRight</code></td>
<td>String</td>
<td>CSS padding shorthand and individual sides.
</td></tr>
<tr>
<td><code>borderColor</code>, <code>borderStyle</code>, <code>borderWidth</code></td>
<td>String</td>
<td>CSS border properties.
</td></tr>
<tr>
<td><code>script</code></td>
<td>String</td>
<td>Control-level code (usually blank; form-level code is preferred).
</td></tr>
<tr>
<td><code>cached_js</code></td>
<td>String</td>
<td>Cached compiled JavaScript for this control (managed by the IDE).
</td></tr>
<tr>
<td><code>cached_js_script_hash</code></td>
<td>String</td>
<td>MD5 hash used to detect when recompilation is needed.
</td></tr>
<tr>
<td><code>children</code></td>
<td>Array</td>
<td>Nested controls (empty for most control types).
</td></tr>
<tr>
<td><code>expanded_pmp</code></td>
<td>String or null</td>
<td>Expansion state in the Project Manager panel (IDE only).
</td></tr></tbody></table>
<div class="mw-heading mw-heading3"><h3 id="Bootstrap_appearance_properties">Bootstrap appearance properties</h3></div>
<p>Controls based on Bootstrap have these additional properties.
</p>
<table class="wikitable">
<tbody><tr>
<th>Property</th>
<th>Type</th>
<th>Description
</th></tr>
<tr>
<td><code>appearance</code></td>
<td>String</td>
<td>Bootstrap contextual class, e.g. <code>" btn-secondary"</code>, <code>" btn-primary"</code>, <code>" btn-danger"</code>.
</td></tr>
<tr>
<td><code>size</code></td>
<td>String</td>
<td>Bootstrap size modifier, e.g. <code>" btn-sm"</code>, <code>" btn-lg"</code>.
</td></tr>
<tr>
<td><code>outline</code></td>
<td>String</td>
<td>Set to <code>"outline-"</code> to use an outlined (hollow) button style.
</td></tr>
<tr>
<td><code>blockLevel</code></td>
<td>String</td>
<td>Set to <code>"true"</code> for a full-width block button.
</td></tr>
<tr>
<td><code>grouping</code></td>
<td>String</td>
<td>Used to group controls into a Bootstrap button group.
</td></tr>
<tr>
<td><code>groupStyle</code></td>
<td>String</td>
<td>Style applied to the button group container.
</td></tr></tbody></table>
<div class="mw-heading mw-heading3"><h3 id="Popover_properties">Popover properties</h3></div>
<p>Most controls support an optional Bootstrap popover.
</p>
<table class="wikitable">
<tbody><tr>
<th>Property</th>
<th>Type</th>
<th>Description
</th></tr>
<tr>
<td><code>popStyle</code></td>
<td>String</td>
<td>Popover style: <code>"popover"</code> or <code>"tooltip"</code>.
</td></tr>
<tr>
<td><code>popTitle</code></td>
<td>String</td>
<td>Popover title text.
</td></tr>
<tr>
<td><code>popBody</code></td>
<td>String</td>
<td>Popover body text.
</td></tr>
<tr>
<td><code>popPosition</code></td>
<td>String</td>
<td>Popover position: <code>"top"</code>, <code>"bottom"</code>, <code>"left"</code>, <code>"right"</code>, or blank for automatic.
</td></tr>
<tr>
<td><code>popClose</code></td>
<td>String</td>
<td>How the popover closes: <code>"hover"</code> or <code>"click"</code>.
</td></tr></tbody></table>
<div class="mw-heading mw-heading3"><h3 id="Badge_properties">Badge properties</h3></div>
<table class="wikitable">
<tbody><tr>
<th>Property</th>
<th>Type</th>
<th>Description
</th></tr>