.
Eloquence JDLG contact contact


JDLG object and attribute reference:
GroupBox class

 
.
  Document revision: 2017-10-11
Refers to JDLG version: 1.7.7


Contents


A GroupBox is a container object. It may be used on any level of the Dialog hierarchy to group any number of child objects.

Optionally, a GroupBox may have a virtual size which may turn it into a scrollable area within a Dialog.

If used as a direct child object of a TabBox, a GroupBox represents a tab in a TabBox.

If used as a direct child object of a Splitter, a GroupBox represents a splitter pane.

accelerator : string, get/set
Specifies the accelerator key used to activate the associated tab in a TabBox.

The accelerator key is specified by the corresponding letter or digit, optionally prefixed with one or more modifiers (ctrl, alt, altGraph, meta).

For example:
 "A"
 "ctrl B"
 "ctrl alt 3"
 "alt 4"

The default value is empty (no accelerator key).

Note: This attribute is used if the GroupBox is a direct child object of a TabBox, i.e., it represents a tab in a TabBox. Otherwise, this attribute has no effect.

bgfill : string, get/set
Specifies the background image fill mode:
"none"  The background image is positioned in the topleft corner of the GroupBox.
"center"  The background image is centered across the GroupBox.
"tile"  The background image is tiled across the GroupBox.
This is the default.
"scale"  The background image is scaled to the GroupBox size.
See also bgimage below.
bgimage : string, get/set
Specifies the URL referring to a GroupBox background image in png, gif or jpg format. The image is tiled across the background if it is smaller than the GroupBox.

If a relative URL is specified, the value of the Application.baseurl or System.baseurl attribute or eloquence.config.baseurl configuration property is prepended.

The default value is empty (no background image).
See also bgfill above.

border : integer, get/set
Specifies the GroupBox border visibility and thickness.

If nonzero, the border is displayed, optionally with a title.
If zero, border and title are not displayed.

If borderstyle is set to "solid", a border value of 1 specifies a thin solid border, while border values greater than 1 specify a thick solid border. If borderstyle is set to "etched", "raised" or "lowered", the border thickness is ignored.

The default border value is 1.

Note: This attribute has no effect if the GroupBox is a direct child object of a TabBox or Splitter.

borderstyle : string, get/set
Specifies the GroupBox border style:
"solid"
(default)
  A solid border is displayed. The border attribute may be used to specify the thickness.
"etched"  A border with an etched 3D effect is displayed.
"raised"  A border with a raised 3D effect is displayed.
"lowered"  A border with a lowered 3D effect is displayed.

If the border attribute is set to zero, border and title are not displayed.

Note: This attribute has no effect if the GroupBox is a direct child object of a TabBox or Splitter.

class : string, get
Returns "GroupBox".
icon : string, get/set
Specifies the URL referring to an icon image in png, gif or jpg format, to be displayed on the associated tab in a TabBox.

If a relative URL is specified, the value of the Application.baseurl or System.baseurl attribute or eloquence.config.baseurl configuration property is prepended.

The default value is empty (icon image not specified).

Note: This attribute is used if the GroupBox is a direct child object of a TabBox, i.e., it represents a tab in a TabBox. Otherwise, this attribute has no effect.

margin : integer, get/set
Used to set the left/right/top/bottom margin attributes to the same value (see below).

On DLG GET, 1 is returned if the left/right/top/bottom margin attributes are all set to a nonzero value, else 0 is returned.

Note: JDLG versions before 1.7.0 do not support individual left/right/top/bottom margins. If the margin attribute is set to a nonzero value, an inner margin is assumed which offsets the position of child objects in the GroupBox. The horizontal margin size is half a raster width, the vertical margin size is half a raster height. The default value is zero (no margin).

marginbottom : integer, get/set
If nonzero, an inner bottom margin is assumed which offsets the position of child objects in the GroupBox. This is used with the yauto vertical layout modes 0 and -1.

The bottom margin size is half a raster height.
The default value is zero (no bottom margin).

Note: Requires JDLG version 1.7.0 or newer.

marginleft : integer, get/set
If nonzero, an inner left margin is assumed which offsets the position of child objects in the GroupBox. This is used with the xauto horizontal layout modes 0 and 1.

The left margin size is half a raster width.
The default value is zero (no left margin).

Note: Requires JDLG version 1.7.0 or newer.

marginright : integer, get/set
If nonzero, an inner right margin is assumed which offsets the position of child objects in the GroupBox. This is used with the xauto horizontal layout modes 0 and -1.

The right margin size is half a raster width.
The default value is zero (no right margin).

Note: Requires JDLG version 1.7.0 or newer.

margintop : integer, get/set
If nonzero, an inner top margin is assumed which offsets the position of child objects in the GroupBox. This is used with the yauto vertical layout modes 0 and 1.

The top margin size is half a raster height.
The default value is zero (no top margin).

Note: Requires JDLG version 1.7.0 or newer.

rule : integer, get/set
Specifies the rule value assigned to the associated tab in a TabBox. If nonzero, this overrides the TabBox rule attribute.

See also the documentation of the TabBox rule attribute.

Note: This attribute is used if the GroupBox is a direct child object of a TabBox, i.e., it represents a tab in a TabBox. Otherwise, this attribute has no effect.

title : string, get/set
Specifies an optional GroupBox title, to be displayed in the GroupBox border. If the border attribute is set to zero, the title is not displayed.

If the GroupBox is a direct child object of a TabBox, this attribute instead specifies the title of the associated tab in the TabBox.

Note: This attribute has no effect if the GroupBox is a direct child object of a Splitter.

vheight : integer, get/set
If nonzero, specifies the virtual height of the GroupBox.

A vertical scroll bar is provided if the virtual height exceeds the visible height.

The default value is zero (virtual height equals visible height).

See also vwidth below.

vwidth : integer, get/set
If nonzero, specifies the virtual width of the GroupBox.

A horizontal scroll bar is provided if the virtual width exceeds the visible width.

The default value is zero (virtual width equals visible width).

See also vheight above.

vx : integer, get/set
Specifies the horizontal scroll bar position of a scrollable GroupBox in Dialog raster units or pixel units, depending on the value of the sizeraster attribute.

See also vwidth above.

Note: Requires JDLG version 1.7.7 or newer.

vy : integer, get/set
Specifies the vertical scroll bar position of a scrollable GroupBox in Dialog raster units or pixel units, depending on the value of the sizeraster attribute.

See also vheight above.

Note: Requires JDLG version 1.7.7 or newer.


 
 
.
 
 
  Privacy | Webmaster | Terms of use | Impressum Revision:  2017-10-11  
  Copyright © 2002-2017 Marxmeier Software AG