This script is used to specify additional options settings in the Options dialog (available from the Tools menu). With this script, you can add your own custom settings. Stonefield Query doesn't use these settings, but another of your scripts could, by calling the GetRegistryValue method of the Application object to retrieve the setting and then doing something with it. In the image below, the "Report on AR data" and "Location of AR data" options are custom settings.

You can validate the values the user enters in your custom settings by creating an Options.Validate script, and receive notification about changes when the user clicks the OK button by creating an Options.Changed script.

Parameters
A reference to the Stonefield Query Application object.

Return Value
An XML string defining the settings to display in the Options dialog. The format for the XML is as follows:

<settings>
  <setting>
    <description>Setting description</description>
    <type>Type of control</type>
    <key>Registry key</key>
    <left>Left position of the control</left>
    <top>Top position of the control</top>
    <filetype>File type</filetype>
    <filedesc>File type description</filedesc>
    <script>Script name</script>
  </setting>
  <setting>
    <description>Setting description</description>
    <type>Type of control</type>
    <key>Registry key</key>
    <left>Left position of the control</left>
    <top>Top position of the control</top>
    <filetype>File type</filetype>
    <filedesc>File type description</filedesc>
    <script>Script name</script>
  </setting>
  ...
</settings>

The following elements are available:

• description: the description for the setting (the text appearing in the Options dialog).

• type: the type of data entry control used for this setting. The choices are:
  • Checkbox: indicates the setting is a Yes/No value and a check box is used.

  • Textbox: indicates the setting is a string and a text box is used.

  • Directory: use this value when the setting is a directory name; a text box with a button the user can click to display existing directories is used.

  • File: this value means the setting is a file name, and a text box with a button the user can click to display file names is used.

  • Dropdown: indicates a drop-down control is used, filled with values returned from the script specified in the "script" element.
    

• key: the Registry key under HKEY_CURRENT_USER\Software\CompanyName\ApplicationName\Options (where CompanyName and ApplicationName are the values of the Company Name and Application Name configuration settings) that holds the value for the setting.

• left: the left position (in pixels, measured from the left edge of the dialog) of the control for this setting. Specify 0 or omit this element to place the control at the next available position.

• top: the top position (in pixels, measured from the top edge of the dialog) of the control for this setting. Specify 0 or omit this element to place the control at the next available position.

• filetype: the type of file to use, specified as "*." followed by the extension (for example, "*.ini"), if type is "file."

• filedesc: the description for the file type, such as "INI Files (*.ini)", if type is "file."

• script: the name of a script that returns XML specifying the options for a drop-down list, if type is "dropdown." The script must return an XML string with the following format:

  <values>
    <value>first value to display</value>
    <value>second value to display</value>
    ...
  </values>

Example
Here's an example that adds two new settings to the Options dialog: a Yes/No setting indicating whether the user can report on AR data, and a directory setting indicating the location of the AR data.

Visual FoxPro

lparameters toApplication as SQApplication
local lcXML
lcXML = '<settings>' + ;
  '<setting>' + ;
  '<description>Report on AR data</description>' + ;
  '<type>Checkbox</type>' + ;
  '<key>AR Data</key>' + ;
  '</setting>' + ;
  '<setting>' + ;
  '<description>Location of AR data</description>' + ;
  '<type>Directory</type>' + ;
  '<key>AR Location</key>' + ;
  '</setting>' + ;
  '</settings>'
return lcXML

VBScript

function Main(Application)
Main = "<settings>" & _
  "<setting>" & _
  "<description>Report on AR data</description>" & _
  "<type>Checkbox</type>" & _
  "<key>AR Data</key>" & _
  "</setting>" & _
  "<setting>" & _
  "<description>Location of AR data</description>" & _
  "<type>Directory</type>" & _
  "<key>AR Location</key>" & _
  "</setting>" & _
  "</settings>"
end function

JavaScript

function Main(Application) {
var cXML ;
cXML = "<settings>" + 
  "<setting>" + 
  "<description>Report on AR data</description>" + 
  "<type>Checkbox</type>" + 
  "<key>AR Data</key>" + 
  "</setting>" + 
  "<setting>" + 
  "<description>Location of AR data</description>" + 
  "<type>Directory</type>" + 
  "<key>AR Location</key>" + 
  "</setting>" + 
  "</settings>" ;
return cXML ;
}

See the topic for the GetRegistryValue method of the Application object for an example that uses these options.

See Also
Options.Changed | Options.Validate | Scripts