An OGLML document consists of a series of (nested) tags, described in detail in the following sections. Each tag can take optional attributes. The following chart lists attributes that can be used with all tags.
Note that there are also tag-specific attributes; these are discussed in the Tags section.
Syntax
<component attribute="value" attribute="value" ... >
General Attributes
Attribute |
Values |
Restrictions |
Description |
bottom inset etched raised lowered tabpage |
|
Adjust the border and shading of the component. See the Examples below. |
|
scroll |
|
Should not be used with “browser” tag. Nesting within another “scrolls” element is not recommended
Scrolling for the “menu” tag will always be true. |
Indicates that the component created by the tag should be enclosed in a scrollable container. If the display is too small to display the component, horizontal or vertical scrollbars are added.
|
true
|
Provides both horizontal and vertical scrollbars |
||
false |
Provides no scrollbars |
||
horizontal |
Provides only horizontal scrolling |
||
vertical |
Provides only vertical scrolling |
||
always |
Forces horizontal and vertical scrollbars to always be visible. |
||
contexttype |
opengear … |
|
|
objectid |
|
|
node-id of the source of parameters within container. The objectid is passed onto child elements and containers. |
objecttype |
|
|
Type of device when communicating wit han openGear of DashBoard connect device. |
id |
String |
Must be unique within all OGLML files displayed by a device.
IDs must only use A-Z, a-z, 0-9, “-“, and “_” characters. |
Used to uniquely identify/reference an element in the OGLML file. |
width |
Positive integer |
Required for browser tags |
Specifies the preferred with (in pixels) for a component. May be ignored by DashBoard depending on the component. |
height |
Positive integer |
Required for browser tags |
Specifies the preferred height (in pixels) for a component. May be ignored by DashBoard depending on the component. |
style |
style hints |
If a parameter already provides style hints as part of its constraint, style hints should not be overridden with this style tag – results are unpredictable. |
openGear Style Hints are used to specify the background color, foreground color, icon, and border for certain components. Refer to Style Hints. |
Examples
The following image illustrates the available containertype values:
Figure 59 – containertype examples