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

checkBoxState

You can use Guide Maker's built-in context check for checkboxes, checkBoxState, to determine the state of a checkbox.

checkBoxState(buttonTitle,   panelName)

buttonTitle

A string specifying the checkbox's title, as defined in a <Checkbox> command.

panelName

A string specifying on which panel the checkbox appears.

DESCRIPTION

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

EXAMPLES

<Define Panel> "Index Choices 2"
   Index choices:

   <Checkbox> "Include See Also entries", TRUE
   <Checkbox> "Include starting and ending page ranges", FALSE
<End Panel>
<Define Sequence> "How do I create an index?"
   <Panel> "Index Choices 2"
   <If> checkBoxState("Include See Also entries", \xAC
                     "Index Choices 2")
         <Panel>  "How do I create See Also entries?")
   <End if>
   <If> checkBoxState("Include starting and ending page ranges", \xAC
                     "Index Choices 2")
      <Panel> "How do I create page ranges for an index entry?"
   <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 <Checkbox> command, see page 10-69.