GroupBox
GroupBox [/Z] ctrlname [ keyword = value [, keyword = value ...] ]
The GroupBox operation creates a box to surround and group related controls.
For information about the state or status of the control, use the ControlInfo operation.
Parameters
ctrlName is the name of the GroupBox control to be created or changed.
The following keyword=value parameters are supported:
| align=alignment | Sets the alignment mode of the control. The alignment mode controls the interpretation of the leftOrRight parameter to the pos keyword. The align keyword was added in Igor Pro 8.00. | ||||||||
| If alignment=0 (default), leftOrRight specifies the position of the left end of the control and the left end position remains fixed if the control size is changed. | |||||||||
| If alignment=1, leftOrRight specifies the position of the right end of the control and the right end position remains fixed if the control size is changed. | |||||||||
| appearance={kind [,platform ]} | |||||||||
| Sets the appearance of the control. platform is optional. Both parameters are names, not strings. | |||||||||
| kind can be one of default, native, or os9. | |||||||||
| platform can be one of Mac, Win, or All. | |||||||||
| See DefaultGUIControls "Groupbox Control Background Details" for how enclosed controls are affected by native groupbox appearance. | |||||||||
| See Button for more appearance details. | |||||||||
| disable=d | Sets user editability of the control. | ||||||||
| |||||||||
| fColor=(r,g,b[,a]) | Sets color of the title text. r, g, b, and a specify the the color and optional opacity as RGBA Values. | ||||||||
| font="fontName" | Sets font for box title. | ||||||||
| frame=f | Sets frame mode. If 1 (the default), the frame has a 3D look. If 0, then a simple gray line is used. Generally, you should not use frame=0 with a title if you want to be in accordance with human interface guidelines. | ||||||||
| fsize=s | Sets font size for box title. | ||||||||
| fstyle=fs | Sets the font style of the title text. fs is a bitwise parameter with each bit controlling one aspect of the font style for the tick mark labels as follows: | ||||||||
| |||||||||
| See Setting Bit Parameters for details about bit settings. | |||||||||
| guides={left, hcenter, right, top, vcenter, bottom} | |||||||||
| Controls attachments of anchor points to layout guides. See Laying Out Controls in Guides Mode for detailed information and examples. | |||||||||
| Each of left, hcenter, right, top, vcenter, bottom is replaced with the name of a layout guide of appropriate orientation. That is, left, hcenter, right indicate attachments to vertical guides, and top, vcenter, bottom indicate attachments to horizontal guides. Use the special name kwNone to represent an unattached anchor point. | |||||||||
| An error results if you overconstrain a control's layout. Of the three horizontal or vertical anchor points, at most two may be attached to layout guides. Attaching one of the three causes a control to move as the layout guide moves. Attaching two causes a control to both move and resize. Thus, the name kwNone will appear at least twice. | |||||||||
| Using kwNone for all anchor points results in completely detaching a control from the layout guides. | |||||||||
| help={helpStr } | Sets the help for the control. | ||||||||
| helpStr is limited to 1970 bytes (255 in Igor Pro 8 and before). | |||||||||
| You can insert a line break by putting "\r" in a quoted string. | |||||||||
| labelBack=(r,g,b[,a]) or 0 | |||||||||
| Sets fill color for the interior. r, g, b, and a specify the the color and optional opacity as RGBA Values. | |||||||||
| If you do not set labelBack then the interior is transparent. | |||||||||
| If an opaque fill color is used, drawing objects cannot be used because they will be covered up. Also, you will have to make sure the GroupBox is drawn before any interior controls. | |||||||||
| The fidelity of the coloring is platform-dependent. | |||||||||
| pos={leftOrRight,top } | Sets the position in control panel units of the top/left corner of the control if its alignment mode is 0 or the top/right corner of the control if its alignment mode is 1. See the align keyword above for details. | ||||||||
| pos+={dx,dy } | Offsets the position of the box in control panel units. | ||||||||
| rename=newName | Gives the control a new name. | ||||||||
| size={width,height } | Sets box size in control panel units. | ||||||||
| title=titleStr | Sets title to titleStr. Use "" for no title. | ||||||||
| userdata(UDName )=UDStr | |||||||||
| Sets the unnamed user data to UDStr. Use the optional (UDName ) to specify a named user data to create. | |||||||||
| userdata(UDName )+=UDStr | |||||||||
| Appends UDStr to the current unnamed user data. Use the optional (UDName ) to append to the named user data. | |||||||||
| win=winName | Specifies which window or subwindow contains the named control. If not given, then the top-most graph or panel window or subwindow is assumed. | ||||||||
| When identifying a subwindow with winName, see Subwindow Syntax for details on forming the window hierarchy. | |||||||||
Flags
| /Z | No error reporting. | |
Details
If no title is given and the width is less than 11 or height is specified as less than 6, then a vertical or horizontal separator line will be drawn rather than a box.
note
Like TabControls, you need to click near the top of a GroupBox in order to select it.
Controls and Control Panels for details about control panels and controls.
Control Panel Units for a discussion of the units used for controls.
The ControlInfo operation for information about the control.
The GetUserData function for retrieving named user data.