Development with Code Generation: Difference between revisions

From OpenPetra Wiki
Jump to navigation Jump to search
Line 20: Line 20:


== Documentation YML for OpenPetra Forms ==
== Documentation YML for OpenPetra Forms ==
* generally the yml files inherit from each other ('''BaseYaml''')
see [[Documentation YAML for OpenPetra Forms]] for details
** this allows us to only define the default menu items once, in PetraForm.yaml, and they will be included in all derived forms
* '''FormType''':
** ''abstract'': if this is just used as a base form for other real forms
** ''navigation'': the main window, the module windows
** ''edit'': edit screens
** ''crud'': CRUD screens (Create, Read, Update, Delete)
** ''find'', ''browse'': find screens
* '''MasterTable''': if this is set, you will need to write less DataField attributes for the controls. The name of the controls will be matched to a field in the given table; if such a table field exists, it will be linked to the control.
* '''DetailTable''': similar to MasterTable, but this is for the detail table; controls must have the word ''Detail'' after the prefix, eg. txtDetailAmount
* '''Events''': here you can link form events to methods in your code
** eg. <code>Activated: {class=System.EventHandler,method=FTheObject.TFrmPetra_Activated}</code>
* '''Actions''': actions can be used by menuitems, toolbarbuttons, and other controls; this is useful to be able to enable/disable an action on the whole screen, and to only define a certain action once, and refer to it from all controls that trigger the same action
** eg. <code>actClose: {Label=&Close, ActionId=eClose, Tooltip=Closes this window, Image=Close.ico}</code>
** eg. <code>actMainMenu: {Label=Petra &Main Menu, ActionClick=FTheObject.OpenMainScreen}</code>
** '''Enabled''': Actions can depend on other actions or conditions; they will be disabled if the condition is false; eg <code>Enabled: cndSelectedSupplier</code>; this can be set in a grid, with '''SelectedRowActivates'''; eg <code>grdSupplierResult: {Dock=Fill, ActionDoubleClick=actSupplierTransactions, SelectedRowActivates=cndSelectedSupplier}</code>
* '''Controls''': see [[Screen scaffolding: controls]]
* '''Menu''': TODO
* '''Toolbar''': TODO
* '''Layout''': TODO

Revision as of 08:59, 17 July 2009

Tools

  • In csharp/ICT/PetraTools
  • uses CSParser to parse existing C# files
  • write code:
    • can comment generated code
    • can insert regions with name ManualCode (need endregion ManualCode as well)
  • TODO: write into Templates
  • Plugin writers for different output (Winforms, GTK, ASP.net)

YML

  • general definition: YML is shorter and easier to write and read than XML, but you can get the same structure than XML. This is achieved for example by not having opening and closing tags, but by using identation to define the hierarchy of elements.
  • specification: http://yaml.org/spec/1.2/
  • see a parser for YAML: http://yaml-net-parser.sourceforge.net/default.html
  • we have our own converter from yaml to xml: project Ict.Tools.CodeGeneration, Yml2Xml.cs, Ict.Tools.CodeGeneration.Yml2Xml
    • advantage: we can write short yaml code, but can use the comfort of the XML parser in .net to walk through the hierarchy
    • yml2xml maps the YAML into XML

XAML

  • TODO: XAML idea

Documentation YML for OpenPetra Forms

see Documentation YAML for OpenPetra Forms for details

Retrieved from ‘https://wiki.openpetra.org/index.php?title=Development_with_Code_Generation&oldid=206’