-
Notifications
You must be signed in to change notification settings - Fork 8
/
codegentask.htm
887 lines (886 loc) · 41.3 KB
/
codegentask.htm
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
<!DOCTYPE HTML>
<html id="hs-topic-p">
<!-- saved from url=(0025)http://www.helpsmith.com/ -->
<head>
<title>CodeGenTask</title>
<meta charset="windows-1252" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="generator" content="HelpSmith 9.8 (Build 23.1026)" />
<link type="text/css" rel="stylesheet" href="../css/topics/style.css" />
<script type="text/javascript" src="../js/jquery-3.7.1.min.js"></script>
<style type="text/css" media="screen">
html {
height: 100%;
}
body {
margin: 0;
}
</style>
<script type="text/javascript" src="../js/settings.js?d3532453"></script>
<script type="text/javascript" src="../js/core.min.js?adb9c364"></script>
<script type="text/javascript" src="../js/topic.min.js?adb9c364"></script>
<script type="text/javascript">
var topicContext = 2350;
</script>
<!-- Web Help Topic -->
<!-- HTML Help (CHM) Topic -->
</head>
<body class="nsa-wrapper">
<div id="nsa-box" class="nsa-content0">
<h1 class="hd0"><span class="ts0">CodeGenTask</span></h1>
</div>
<div id="sa-box">
<div id="content-box" class="sa-content0">
<p> </p>
<p class="ps1"><span class="ts2">Represents a single code generation task within a </span><a href="codegentaskset.htm" class="hs0">task set</a><span class="ts2">.</span></p>
<p class="ps1"><span class="ts2">For an example of generating code with the CodeGen API look </span><a href="codegenapi.htm#CodeExample" class="hs2">here</a><span class="ts2">.</span></p>
<h2 class="hd1"><span class="ts1">Syntax</span></h2>
<p class="ps1"><span class="ts2">Definition: </span> <span class="ts3">public class CodeGenTask</span></p>
<p class="ps1"><span class="ts2">Namespace:</span> <span class="ts3">CodeGen.Engine</span></p>
<p class="ps1"><span class="ts2">Assembly:</span> <span class="ts2">CodeGenEngine.dll</span></p>
<h2 class="hd1"><span class="ts1">Constructors</span></h2>
<div class="block0">
<table class="tbl0">
<tr class="row0">
<td class="cell50">
<p><span class="ts5">Name</span></p>
</td>
<td class="cell51">
<p><span class="ts5">Description</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell52">
<p><span class="ts2">CodeGenTask</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell51">
<p><span class="ts2">Initializes a new instance of the CodeGenTask class.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell53">
<p><span class="ts2">CodeGenTask(String, String)</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell54">
<p><span class="ts2">Initializes a new instance of the CodeGenTask class for a specified template and structure.</span></p>
</td>
</tr>
</table>
</div>
<h2 class="hd1"><span class="ts1">Properties Set by Calling Application Before Processing</span></h2>
<div class="block0">
<table class="tbl0">
<tr class="row0">
<td class="cell55">
<p><span class="ts5">Name</span></p>
</td>
<td class="cell56">
<p><span class="ts5">Type</span></p>
</td>
<td class="cell57">
<p><span class="ts5">Description</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">Aliases</span></p>
</td>
<td class="cell59">
<p>@ObservableCollection<string></p>
</td>
<td class="cell60">
<p><span class="ts2">The alias names for one or more structures. The number of aliases specified must be less than or equal to the number of structures specified via the Structures property. Setting this property is the equivalent of using the </span><span class="ts5">-a</span><span class="ts2"> command line option. If a task does not list aliases but the TaskSet does then those aliases will be used.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">AllowTemplateFolder</span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Allow template files to specify an output sub-folder. If this property is false then any </span><a href="fileheadertokens.htm#%3CCODEGEN_FOLDER%3E" class="hs2"><CODEGEN_FOLDER></a><span class="ts2"> tokens will be ignored. Setting this property to true is the equivalent to using the </span><span class="ts5">-tf</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">AlwaysLoadDefaultButtons</span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Always load default button definitions from DefaultButtons.xml even if processing a UI Toolkit input window definition which may provide button definitions. Setting this property is the equivalent of using the </span><span class="ts5">-ba</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">CharacterHeight</span></p>
</td>
<td class="cell59">
<p>int</p>
</td>
<td class="cell60">
<p><span class="ts2">The height of a character in pixels. This property can be used to override the default character height which is 25 pixels. Setting this property is the equivalent of using the </span><span class="ts5">-ch</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">CharacterWidth</span></p>
</td>
<td class="cell59">
<p>int</p>
</td>
<td class="cell60">
<p><span class="ts2">The width of a character in pixels. This property can be used to override the default character width which is 12 pixels. Setting this property is the equivalent of using the </span><span class="ts5">-cw</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">Description</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p><span class="ts2">A description of the task. Not used by CodeGen, but it may be useful for consuming code to display task descriptions in their UI. There is no command-line equivalent to this property.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">DontAppendFolderToNamespace</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">When using a template defined folder name, that name is usually appended to the end of any namespace that is used. This option prevents that from happening. Setting this property to true is the equivalent to using the </span><span class="ts5">-nf</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">ExplicitGroupNoExpand</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Don't expand explicit groups to individual fields. Setting this property to true is equivalent to using the </span><span class="ts5">-g e</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">FieldPrefix</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p><span class="ts2">Field prefix. Setting this property is the equivalent of using the </span><span class="ts5">-prefix</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell55">
<p><span class="ts2">FileOverrides</span></p>
</td>
<td class="cell56">
<p>@ObservableCollection<string></p>
</td>
<td class="cell57">
<p><span class="ts2">File Overrides. Allows you to specify which repository file definition is used for each structure being processing. This option is useful if the structure that you are using is assigned to multiple files because by default CodeGen will use the first assigned file. The number of file overrides provided must be less than or equal to the number of structures specified via the Structures property. Setting this property is the equivalent of using the </span><span class="ts5">-fo</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">GroupFieldNoGroupPrefix</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Don't prefix group fields with group name. Setting this property is the equivalent of using the </span><span class="ts5">-g f</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">GroupFieldNoRpsPrefix</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Don't use repository group field prefix. Setting this property is the equivalent of using the </span><span class="ts5">-g r</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">ImplicitGroupNoExpand</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Don't expand implicit groups to individual fields. Setting this property is the equivalent of using the </span><span class="ts5">-g i</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">HonorExcludeReportWriter</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Exclude fields which are "Excluded by ReportWriter". Setting this property is the equivalent of using the </span><span class="ts5">-f r</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">HonorExcludeToolkit</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Exclude fields which are "Excluded by Toolkit". Setting this property is the equivalent of using the </span><span class="ts5">-f t</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">HonorExcludeWeb</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Exclude fields which are "Excluded by Web". Setting this property is the equivalent of using the </span><span class="ts5">-f w</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">IncludeOverlayFields</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Include overlay fields when processing field loops. Setting this property to true is equivalent to using the </span><span class="ts5">-f o</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">IgnoreExcludeLanguage</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Exclude fields which are "Excluded by Web". Setting this property is the equivalent of using the </span><span class="ts5">-f l</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">IgnoreScriptFieldAttributes</span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">When processing input from a UI Toolkit Window script file this option prevents script file input window field attributes from being used to override repository field attributes. This allows you to generate code based on only the fields listed in an input window, but using only the repository field definitions. Setting this property is the equivalent of using the </span><span class="ts5">-wn</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p>MethodCatalogExcludeMethods</p>
</td>
<td class="cell59">
<p>@ObservableCollection<string></p>
</td>
<td class="cell60">
<p>The names of one or more methods in the Synergy method catalog interface to exclude. Setting this property is equivalent to using the <span class="ts5">-mexclude</span> command line option.</p>
<p> </p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p>MethodCatalogFile</p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p>The synergy method catalog XML export file to process. Setting this property is equivalent to using the <span class="ts5">-smc</span> command line option.</p>
<p> </p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p>MethodCatalogIncludeMethods</p>
</td>
<td class="cell59">
<p>@ObservableCollection<string></p>
</td>
<td class="cell60">
<p>The names of one or more methods in the Synergy method catalog interface to include. Setting this property is equivalent to using the <span class="ts5">-minclude</span> command line option.</p>
<p> </p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p>MethodCatalogInterface</p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p>The name of the method catalog interface to process. Setting this property is equivalent to using the <span class="ts5">-interface</span> command line option.</p>
<p> </p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p>MethodCatalogInterfaces</p>
</td>
<td class="cell59">
<p>@ObservableCollection<string></p>
</td>
<td class="cell60">
<p>The names of one or more interfaces in the Synergy method catalog to process. Setting this property is equivalent to using the <span class="ts5">-iloop</span> command line option.</p>
<p> </p>
</td>
</tr>
<tr class="row0">
<td class="cell61">
<p>MethodCatalogStructureMode</p>
<p> </p>
</td>
<td class="cell62">
<p>Boolean</p>
</td>
<td class="cell63">
<p><span class="ts2">The name of the method catalog interface to process. Setting this property is the equivalent of using the </span><span class="ts5">-interface</span><span class="ts2"> command line option, and it can only be used in conjunction with the </span><a href="codegentaskset.htm#MethodCatalog" class="hs2">CodeGenTaskSet.MethodCatalog</a><span class="ts2"> property (-smc).</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">MultipleStructures</span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Multiple Structures. Specifies that the structures that follow the -s command line option should all be available to templates being processed, at the same time. Setting this property is the equivalent of using the </span><span class="ts5">-ms</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">MultiWriteFiles</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Multi-write file if same file generated more than once. Setting this property is the equivalent of using the </span><span class="ts5">-mw</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">Namespace</span></p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p><span class="ts2">Namespace to use when replacing the <NAMESPACE> token. Codegen will determine the default namespace using the environment variable SYNDEFNS. Setting this property is the equivalent of using the </span><span class="ts5">-n</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p>NeverLoadAnyButtons</p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Never load any buttons (from DefaultButtons.xml or from a window script). Setting this property is the equivalent of using the </span><span class="ts5">-bn</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p>NeverLoadDefaultButtons</p>
<p> </p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Never use the default buttons defined in DefaultButtons.xml. Setting this property is the equivalent of using the </span><span class="ts5">-bd</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p>NoCustomPluralization</p>
<p> </p>
</td>
<td class="cell59">
<p><span class="ts2">Boolean</span></p>
</td>
<td class="cell60">
<p>Suppresses the features of the <STRUCTURE_PLURAL> and <STRUCTURE_NOPLURAL> tokens, making them behave the same as <STRUCTURE_NAME>. Setting this property is the equivalent of using the <span class="ts5">-ncp</span> command line option.</p>
<p> </p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p>OutputFolder</p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p><span class="ts2">Output directory. Defaults to the current directory, or the directory specified with the CODEGEN_OUTDIR environment variable. You can use a full or relative path, or a logical followed by a colon (e.g. SRC:). Setting this property is the equivalent of using the </span><span class="ts5">-o</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p>PreProcessUserTokens</p>
<p> </p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Should we treat user-defined tokens as pre-processor tokens. If this property is set to true then user-defined tokens will be expanded out</span></p>
<p><span class="ts2">to other tokens during tokenization, thus making it possible for the value of user defined tokens to contain other tokens. Setting this property to true is equivalent to using the </span><span class="ts5">-utpp</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">PreserveArrays</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Should array fields be preserved instead of expanded to multiple fields. Setting this property is equivalent to using the </span><span class="ts5">-pa</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">PrimaryKeyNumber</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>int</p>
</td>
<td class="cell60">
<p><span class="ts2">Overrides the key that is used within primary key blocks. Setting this property is the equivalent of using the </span><span class="ts5">-opk</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">ReplaceFiles</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Replace existing files. By default existing files are not replaced. Setting this property is the equivalent of using the </span><span class="ts5">-r</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">RepositoryFile</span></p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p><span class="ts2">Repository file name to process. This option causes all structures that are assigned to the file definition to be available for use when processing templates. The result is the same as specifying multiple structures via the Structures property and setting the MultipleStructures property to true. Setting this property is the equivalent of using the </span><span class="ts5">-file</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">RepositoryMainFile</span></p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p><span class="ts2">Repository main file to use only for this task. The repository main file can also be set via the </span><a href="codegentaskset.htm#RepositoryMainFile" class="hs2">CodeGenTaskSet.RepositoryMainFile</a><span class="ts2"> property which specifies the same repository main file for all tasks. Setting this property is also the equivalent of setting the </span><span class="ts5">RPSMFIL</span><span class="ts2"> environment variable.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">RepositoryTextFile</span></p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p><span class="ts2">Repository text file to use only for this task. The repository text file can also be set via the </span><a href="codegentaskset.htm#RepositoryTextFile" class="hs2">CodeGenTaskSet.RepositoryTextFile</a><span class="ts2"> property which specifies the same repository text file for all tasks. Setting this property is also the equivalent of setting the </span><span class="ts5">RPSTFIL</span><span class="ts2"> environment variable.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">RepositoryOverrideFile</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p><span class="ts2">Specifies the name of a repository override file. Setting this property is the equivalent of using the </span><span class="ts5">-rpsoverride</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">SelectionWindowScript</span></p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p><span class="ts2">Window script selection list processing. When this option is used CodeGen will examine any fields which have selection windows specified and will attempt to populate the field selections property based on the selection items defined in the named selection window. Setting this property is the equivalent of using the </span><span class="ts5">-ws</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">Structures</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>@ObservableCollection<string></p>
</td>
<td class="cell60">
<p><span class="ts2">The names of one or more repository structures to be processed. If no structures are specified but the TaskSet does specify structures then those structures will be used. Setting this property is the equivalent of using the </span><span class="ts5">-s</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">Subset</span></p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p><span class="ts2">Subset of fields to use. Specify subsets in field user text strings with @SUB=name; syntax. Setting this property is the equivalent of using the </span><span class="ts5">-subset</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">SubsetFields</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>@ObservableCollection<Tuple<String, String>></p>
</td>
<td class="cell60">
<p><span class="ts2">Create a subset from the list of supplied fields. Setting this property is the equivalent of using the </span><span class="ts5">-fields</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">TemplateFolder</span></p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p><span class="ts2">Input file directory containing templates. Defaults to the current directory, or the directory specified with the CODEGEN_TPLDIR environment variable. You can specify a full or relative path, or a logical name followed by a colon (e.g. TPL:). Setting this property is the equivalent of using the </span><span class="ts5">-i</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">Templates</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>@ObservableCollection<string></p>
</td>
<td class="cell60">
<p><span class="ts2">The names of one or more template files to be processed. Specify only the base file name, not including the location or file extension. Setting this property is the equivalent of using the </span><span class="ts5">-t</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">Tweaks</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>@ObservableCollection<string></p>
</td>
<td class="cell60">
<p>This is a named collection of special "tweaks" to be applied when generating code. Setting this property is the equivalent to using the <span class="ts5">-tweaks</span> command line option.</p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">UseAlternateFieldNames</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Should alternate field names be used? Setting this property is the equivalent of using the </span><span class="ts5">-af</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">UseAlternateStructureNames</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>Boolean</p>
</td>
<td class="cell60">
<p><span class="ts2">Should alternate structure names be used? Setting this property is the equivalent of using the </span><span class="ts5">-as</span><span class="ts2"> command line option. This option may not be combined with structure aliasing (-a).</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">UserTokenFile</span></p>
</td>
<td class="cell59">
<p>String</p>
</td>
<td class="cell60">
<p><span class="ts2">User defined token file. Specify a full or relative file spec of the file that contains user defined token definitions. The file spec can include Synergy logical names. Setting this property is the equivalent of using the </span><span class="ts5">-u</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
<tr class="row0">
<td class="cell58">
<p><span class="ts2">UserTokens</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell59">
<p>@ObservableCollection<<span class="ts2">UserToken</span>></p>
</td>
<td class="cell60">
<p><span class="ts2">User defined tokens. Setting this property is the equivalent of using the </span><span class="ts5">-ut</span><span class="ts2"> command line option.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell55">
<p><span class="ts2">WindowScript</span></p>
</td>
<td class="cell56">
<p>String</p>
</td>
<td class="cell57">
<p><span class="ts2">Process input from a UI Toolkit Window script file. By default the fields and buttons collection will be based on the first input window found in the script file, but this can be overridden using the #n qualifier, which specifies either a 1-based input window number or the name of the input window to process. Setting this property is the equivalent of using the </span><span class="ts5">-w</span><span class="ts2"> command line option.</span></p>
<p><span class="ts2"> </span></p>
</td>
</tr>
</table>
</div>
<h2 class="hd1"><span class="ts1">Properties Set by CodeGenerator During Processing</span></h2>
<div class="block0">
<table class="tbl0">
<tr class="row0">
<td class="cell64">
<p><span class="ts5">Name</span></p>
</td>
<td class="cell65">
<p><span class="ts5">Type</span></p>
</td>
<td class="cell66">
<p><span class="ts5">Description</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell67">
<p><span class="ts2">Complete</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell68">
<p><span class="ts2">Boolean</span></p>
</td>
<td class="cell69">
<p><span class="ts2">Indicates whether the task completed without any errors and warnings.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell67">
<p><span class="ts2">Errors</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell68">
<p><span class="ts2">int</span></p>
</td>
<td class="cell69">
<p><span class="ts2">Number of errors reported while processing the task.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell67">
<p><span class="ts2">FilesFailed</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell68">
<p><span class="ts2">int</span></p>
</td>
<td class="cell69">
<p><span class="ts2">Number of files that failed to generate while processing the task.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell67">
<p><span class="ts2">FilesGenerated</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell68">
<p><span class="ts2">ObservableCollection<String></span></p>
</td>
<td class="cell69">
<p><span class="ts2">Names of files that were generated while processing the task.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell67">
<p><span class="ts2">FilesProvided</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell68">
<p><span class="ts2">ObservableCollection<String></span></p>
</td>
<td class="cell69">
<p><span class="ts2">Names of additional files that were provided while processing the task.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell67">
<p><span class="ts2">LastErrorMessage</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell68">
<p><span class="ts2">String</span></p>
</td>
<td class="cell69">
<p><span class="ts2">The last error message that was reported while processing the task.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell67">
<p><span class="ts2">Messages</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell68">
<p><span class="ts2">ObservableCollection<String></span></p>
</td>
<td class="cell69">
<p><span class="ts2">All messages that were reported while processing the task.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell67">
<p><span class="ts2">Warnings</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell68">
<p><span class="ts2">int</span></p>
</td>
<td class="cell69">
<p><span class="ts2">Number of warnings reported while processing the task.</span></p>
</td>
</tr>
</table>
</div>
<h2 class="hd1"><span class="ts1">Events Raised During Processing</span></h2>
<div class="block0">
<table class="tbl0">
<tr class="row0">
<td class="cell70">
<p><span class="ts5">Name</span></p>
</td>
<td class="cell71">
<p><span class="ts5">Description</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell70">
<p><span class="ts2">StartingTask</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell71">
<p><span class="ts2">Raised by CodeGenerator just before it starts processing the task.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell70">
<p><span class="ts2">TaskComplete</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell71">
<p><span class="ts2">Raised by CodeGenerator just after it finishes processing the task.</span></p>
</td>
</tr>
<tr class="row0">
<td class="cell72">
<p><span class="ts2">TaskMessage</span></p>
<p><span class="ts2"> </span></p>
</td>
<td class="cell73">
<p><span class="ts2">A message was just added to the Messages collection.</span></p>
</td>
</tr>
</table>
</div>
<p class="ps1"><span class="ts2"> </span></p>
<p><span class="ts2"> </span></p>
<p><span class="ts2"> </span></p>
<div class="hr-wrapper">
<hr class="hline1" />
</div>
<p class="ps8"><span class="ts10">Copyright © 2021 Synergex International, Inc.</span></p>
</div>
</div>
</body>
</html>