This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %ZEN.Component.radioSet


class %ZEN.Component.radioSet extends %ZEN.Component.listControl

This is a specialized control that displays a complete set of radio buttons based on a list of values.
The list of values is specified by the valueList. This is a csv-list of values that the user can select. If displayList is provided, it is used to provide the displayed captions for the buttons.
If there is an empty value ("") within the items in valueList (e.g., ",A,B,C"), then an additional button will be displayed for the empty value. The caption for this empty value is specified by the emptyCaption.
It is assumed that every value within the set of value is distinct; A valueList containing duplicate items (e.g., "A,A,A") will lead to strange beahavior for the user.
It is possible to programmatically set the value of the radioSet to any arbitary value using the setValue() method. If the value of the radioSet does not correspond to an item in the set of values, then all buttons in the set will be unchecked.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property captionClass as %ZEN.Datatype.cssClass [ InitialExpression = "radioSetCaption" ];
CSS class to apply to the control's captions.
Property methods: captionClassDisplayToLogical(), captionClassGet(), captionClassIsValid(), captionClassLogicalToDisplay(), captionClassLogicalToOdbc(), captionClassNormalize(), captionClassSet()
property emptyCaption as %ZEN.Datatype.caption [ InitialExpression = "None" ];
This caption is used for any radio buttons within this radioSet that have an empty ("") display value.
Property methods: emptyCaptionDisplayToLogical(), emptyCaptionGet(), emptyCaptionIsValid(), emptyCaptionLogicalToDisplay(), emptyCaptionLogicalToOdbc(), emptyCaptionNormalize(), emptyCaptionSet()
property layout as %ZEN.Datatype.string (VALUELIST = ",horizontal,vertical") [ InitialExpression = "horizontal" ];
Specifies whether the radio buttons appear horizontally (default) or vertically
Property methods: layoutDisplayToLogical(), layoutGet(), layoutIsValid(), layoutLogicalToDisplay(), layoutLogicalToOdbc(), layoutNormalize(), layoutSet()
property optionCount as %ZEN.Datatype.integer (XMLPROJECTION = "none") [ InitialExpression = 0 ];
Count of options within this radioSet.
Property methods: optionCountDisplayToLogical(), optionCountGet(), optionCountIsValid(), optionCountLogicalToDisplay(), optionCountLogicalToOdbc(), optionCountNormalize(), optionCountSet()
property titleList as %ZEN.Datatype.csv (ZENLOCALIZE = 1);
Defines set of titles (tooltip text) for each of the choices of this radioSet as a csv-list.
Property methods: titleListDisplayToLogical(), titleListGet(), titleListIsValid(), titleListLogicalToDisplay(), titleListLogicalToOdbc(), titleListNormalize(), titleListSet()

Methods (Including Private)

method %DrawHTML()
Inherited description: Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
method %SetDefaultValues()
This method fills in reasonable default values for this control. Used by tools (such as Control Tester) to dynamically create controls.
clientmethod clickItem(choice) [ Language = javascript ]
User click on radio button or caption for radio button choice; select associated button and invoke callbacks.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)