Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

iconTextRadioCollection [-collectionItemArray] [-defineTemplate string] [-disableCommands] [-exists] [-global boolean] [-numberOfCollectionItems] [-parent string] [-select string] [-useTemplate string] [string]

iconTextRadioCollection is undoable, queryable, and editable.

This command creates a cluster for iconTextRadioButtons. Clusters will be parented to the current default layout if no parent is specified with the -p/parent flag. As children of the layout they will be deleted when the layout is deleted. Clusters may also span more than one window if the -g/global flag is used. In this case the cluster has no parent so must be explicitly deleted with the 'deleteUI' command.

Return value

stringThe name of the iconTextRadioCollection created.

In query mode, return type is based on queried flag.

Flags

collectionItemArray, defineTemplate, disableCommands, exists, global, numberOfCollectionItems, parent, select, useTemplate
Long name (short name) Argument types Properties
-collectionItemArray(-cia) query
Returns a string list giving the long names of all the items in this collection.
-defineTemplate(-dt) string create
Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
-disableCommands(-dcm) edit
Allows a particular iconTextRadioButton in the collection to be selected without invoking the commands attached to the -cc/changeCommand, -onc/onCommand, or -ofc/offCommand flags. This flag is only meaningful when used in conjuction with the -edit and -select flags.
-exists(-ex) create
Returns whether the specified object exists or not. Other flags are ignored.
-global(-gl) boolean createquery
Set the collection to have no parent layout. If the collection has a parent layout then it will be deleted with that layout, otherwise if it is specified to be global it must be explicitly deleted.
-numberOfCollectionItems(-nci) query
Returns the number of items that are in this collection.
-parent(-p) string create
Set the specified layout to be the parent layout of the cluster.
-select(-sl) string createqueryedit
Select the specified collection item. If queried will return the name of the currently selected collection item.
-useTemplate(-ut) string create
Forces the command to use a command template other than the current one.
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

window -tlc 100 400;
       columnLayout -adj true;
               iconTextRadioCollection itRadCollection;
               iconTextRadioButton -st "textOnly"
                       -i1 "sphere.png" -l "sphere";
               iconTextRadioButton -st "iconOnly"
                       -i1 "spotlight.png" -l "spotlight";
               iconTextRadioButton -st "iconAndTextHorizontal"
                       -i1 "cone.png" -l "cone";
               iconTextRadioButton -st "iconAndTextVertical"
                       -i1 "cube.png" -l "cube";
   showWindow;