Adams Basic Package > Adams View > View Command Language > interface > interface label modify

interface label modify

Allows modification of an existing label on the dialog box.
Specification of a label for an axis is displayed near the axis, its placement depending on where the axis is placed. The label can be of unlimited length, but may not all fit on the plot if it's very long. If the string contains spaces, it must be enclosed in quotation marks.

Format:

 
interface label modify
label_name =
an existing GI_label
new_label_name =
a new GI_lable
location =
real
height =
real
width =
real
enabled =
boolean
help_text =
string
documentation_text =
string
units =
int_units
horiz_resizing =
int_h_resize
vert_resizing =
int_v_resize
text =
string
icon_file =
string
justified =
justified

Example:

 
interface label modify &
label_name =
.gui.dbox.lbl &
new_label_name =
.gui.dbox.lbl &
location =
0.0, 0.0 &
height =
0.8 &
width =
0.8 &
enabled =
yes &
help_text =
"help2text" &
documentation_text =
"doc2text" &
units =
relative &
horiz_resizing =
attach_left &
vert_resizing =
attach_top &
text =
"this_is_label" &
justified =
center

Description:

 
Parameter
Value Type
Description
label _name
An Existing GI_label
Specifies the name of an existing label
new_label_name
A New GI_label
Specifies a new name for an existing label
enabled
Boolean
Activates the label
help_text
String
Specifies the help text
documentation_text
String
Specifies the documentation text
units
Int_units
Specifies the label size as pixel or relative to dialog box window
horiz_resizing
Int_h_resize
Specifies the attachment and scaling option for the label
vert_resizing
Int_v_resize
Specifies the attachment and scaling option for the label
location
Real
Specifies the location of the label on the dialog box
height
Real
Specifies the height of the label in terms of relative units or pixel
width
Real
Specifies the width of the label field in terms of relative units or pixel
icon_file
String
Specifies the address of the image to be displayed for iconic label
text
String
Specifies the text to be displayed on the label
justified
Justified
Specifies the text justification on the window

Extended Definition:

1. The preliminary parameters of the label like size and text to be displayed are set using this command. The name of the label can also be change by adding parameter ‘new_label_name’.
2. The pop-up help and documentation help can be specified in appropriate columns.
3. The size of the label can be specified either in terms of number of pixels. Alternatively, the size can also be stated as relative to the dialog box window
4. The vertical and horizontal resizing options are used to adjust the placement of the label menu on existing dialog box. For example, attach_left; attach_top options for Horiz_resizing and Vert_resizing will place the label on the top left corner of the dialog box. The location can also be specified from the top left corner by adjusting the parameter ‘location’
5. The size of the label window can be specified with respect to the dialog box window size. The value for parameter height and width should be a real number between 0.0 and 2.0, where 2.0 represents the height of the dialog window. Therefore, a value of 1.0 will set the label field window to be one half as high as the dialog box window.
6. By default ‘label’ is left justified, but it can be adjusted center or right by parameter ‘JUSTIFIED’
7. The parameter ‘iconic_file’ specifies the name of the file that contains the icon definition for use on an iconic menu.