Designer - How To:
Quick Objects Designer provides a few command line arguments that can be used to control the designer application. The designer application provides a flexible approach to complete automation of code generation and schema refresh etc.
The designer application's console mode expects that you pass the path to the ".qos" file as the first parameter. |
| Parameter | Description | |
| Path to the .QOS file | Passing the path of the .QOS file as a parameter to the Designer application opens the file in the Designer. If you want to use any other parameter, the file path is a requirement. | |
| /r | Refresh parameter instructs the designer application to automatically refresh the schema from the underlying database. Please see "/int" and "/inc" options for ways you can control the refresh behavior further. | |
| /s | Silent parameter instructs the designer application to suppress the confirmation dialog boxes. | |
| /c | Close parameter can be used to close the designer application after it completes the requested tasks. | |
| /gb | GenBase parameter instructs the designer application to generate the base classes automatically. The path stored in the project options is used as the target path. The language used by default is C#, to use VB please see the /vb parameter. | |
| /gc |
GenCustom parameter instructs the designer application to generate the custom classes automatically. The path stored in the project options is used as the target path. The language used by default is C#, to use VB please see the /vb parameter.
| |
| /vb |
VB.NET parameter can be used to have the designer generate the classes in VB.NET. By default the designer uses C# for the generated classes. This parameter is only applicable if /gb or /gc parameters are also supplied. | |
| /int | IncludeNewTables parameter can be combined with the "Refresh" parameter. This parameter ensures that any new tables that have been added to the database since the last schema was fetched will be automatically included in the code generation. All columns for the new tables are automatically included as well. | |
| /inc |
IncludeNewColumns parameter can be combined with the "Refresh" parameter. This parameter automatically includes any new columns that have been added to any of the tables already in the loaded schema. This does not apply to any columns that are part of the new tables. |
Example 1 - Automatically refresh schema and regenerate the base class files in C#
QuickObjects.Designer.exe "c:\myfolder\myschema.qos" /r /s /c /gb /gc /int /incThe above set of parameters will cause the Designer application to refresh the schema stored at the supplied path. During the refresh process any new tables and columns will be automatically included.
The designer application will automatically generate the base and custom class files in C#. Please Note: If any new tables are added then the corrosponding class files must be manually added to the project/build.
At the end of the process the Designer application will automatically close.
The application will run in silent mode and all confirmation and alerts will be suppressed.
Example 2 - Automatically refresh schema and regenerate the base and custom class files in VB.NET
QuickObjects.Designer.exe "c:\myfolder\myschema.qos" /r /s /gb /inc /vbThe above set of parameters will cause the Designer application to refresh the schema stored at the supplied path. During the refresh process only new columns in the existing tables will be automatically included.
The designer will generate the base class files in VB.NET.
The application will run in silent mode and all confirmation and alerts will be suppressed.
Example 3 - Regenerate the base class files.
QuickObjects.Designer.exe "c:\myfolder\myschema.qos" /s /c /gbThe above set of parameters will cause the Designer application simply regenerate the base class files. The application will run in Silent mode, and will automatically close once the generation is complete.