WebComponent setup (advanced)

To make Web Components available for Genero Studio form designers, the description of the Web Component must be described in an XML file with the extension .wcsettings.

Create a separate XML file to describe each WebComponent using the format name.wcsettings; storecalendar.wcsettings for example. The componentType property in the Properties View is a combobox that displays the names of the available WebComponent widgets ("storecalendar" for example).

You can display an icon on the form design document when a web component is selected; otherwise the default icon is displayed. The name of the icon file must be the same as that of the wcsettings file. For example, the storecalendar WebComponent would have storecalendar.wcsettings and storecalendar.jpg.

The form designer must specify the directory that contains the wcsettings and icon files. See Add a WebComponent to a form.

WebComponent description files

Example file chart.wcsettings:

<?xml version="1.0" encoding="utf-8"?>
<WebComponent>
  <DynamicProperty name="type" type="TEXT" label="type"
   description="type of chart"
   initialValue="" />
  <DynamicProperty name="caption" type="TEXT" label="caption"
   description="caption"
   initialValue="" />
  <DynamicProperty name="subcaption" type="TEXT" label="subcaption"
   description="subcaption" initialValue="" />    
  <DynamicProperty name="xaxisname" type="TEXT" label="X label"
   description="label of X axis" initialValue="" />    
  <DynamicProperty name="yaxisname" type="TEXT" label="Y label"
   description="label of Y axis" initialValue="" />    
  <DynamicProperty name="numberPrefix" type="TEXT" label="numberPrefix"
   description="number prefix" initialValue="" />    
  <DynamicProperty name="labels" type="STRINGLIST" label="labels"
   description="labels" initialValue="" />    
  <DynamicProperty name="values" type="STRINGLIST" label="value"
   description="values"
   initialValue="" />    
</WebComponent>

The XML schema description for the .wcsettings file is contained in an XSD file named wcsettings.xsd, located in the Genero Studio installation directory GSTDIR/conf/schema.