WEBCOMPONENT item type

WEBCOMPONENT item basics

The WEBCOMPONENT form item defines a form field that will hold an external component, implemented with a front-end plug-in mechanism.

This topic describes the WEBCOMPONENT item type in form definition files, a complete section is dedicated to web component programming.

Defining a WEBCOMPONENT

The COMPONENTTYPE attribute identifies gICAPI external objects to be used for the field. The PROPERTIES attribute is typically used to define attributes that are specific to a given gICAPI-based web component. For example, a chart component might have properties to define x-axis and y-axis labels. For more details, see Using a gICAPI web component.

If the COMPONENTTYPE attribute is not used, the web component will be a URL-based web component. For more details, see Using a URL-based web component.

Some front-ends support different presentation and behavior options, which can be controlled by a STYLE attribute. For more details, see Common style attributes.

Where to use a WEBCOMPONENT

A WEBCOMPONENT form item can be defined in two different ways:

With an item tag and a WEBCOMPONENT item definition in a grid-layout container (GRID, SCROLLGRID and TABLE).
As a WEBCOMPONENT stack item in a STACK container.

Defining the widget size

The size of a WEBCOMPONENT widget can be controlled in grid-based or stack-based layout, according to several attributes such as SIZEPOLICY and STRETCH.

For more details about image sizing, see Controlling the web component layout.