Legacy Document

Inside Macintosh: Apple Guide Complete / Part 4 - Scripting Guide Files

Chapter 10 - Guide Script Command Reference / Guide Script Command Descriptions

/ Defining and Using Context Checks

radioButtonState

You can use Guide Maker's built-in context check for radio buttons, radioButtonState, to determine the state of a radio button.

radioButtonState(buttonTitle,   panelName)

buttonTitle

A string specifying the radio button's title, as defined in a <Radio Button> command.

panelName

A string specifying on which panel the radio button appears.

DESCRIPTION

The radioButtonState context check returns the state of the specified radio button. It returns TRUE if the radio button is on, FALSE if the radio button is off. You usually use the radioButtonState context check in conjunction with <If>, <Else>, or <Skip If> commands.

EXAMPLES

<Define Panel> "Index Choices 2"
   #Label for this group of radio buttons
   What type of index do you want to create?

   <Radio Button> "Book Index", TRUE
   <Radio Button> "Chapter Index", FALSE
<End Panel>

<Define Sequence> "How do I create an index?"
   <Panel> "Index Choices 2"
   <If> radioButtonState("Book Index", "Index Choices 2")
      <Panel> "How do I create a book index?"
   <Else>
      <Panel> "How do I create a chapter index?"
   <End if>
<End Sequence>

SEE ALSO

For information on the <If>, <Else>, and <Skip If> commands, see page 10-153, page 10-156, and page 10-160, respectively. For information on the <Radio Button> command, see page 10-64.