<optionparammenu>

Description

Used for any object (JavaScript) to specify options array hinting for the arguments that the method or function takes. An options array is an argument that can have subarguments in the form of option:value. Most Spry objects use an options array argument to allow users to configure the behavior of an object (for example, a data set, widget, or effect). Options arrays generally appear as {option1: value1, option2: value2, option3: value3, ...}

Attributes

pattern, label, value, icon, type

  • The pattern attribute specifies the character(s) that trigger the code hints menu. This argument is required.

  • The label attribute specifies the name of the parameter. This argument is required.

  • The value attribute specifies the value of the parameter to insert when the user selects the code hint. This argument is required.

  • The icon attribute specifies the icon to be used. This argument is required.

  • The type attribute specifies the data type. The following data types are supported:
    • enumerated (the default), which indicates a list of nested optionparammenuitem to display.

    • spryDataReferences, which indicates a list of Spry data set columns.

    • cssStyle, which indicates a list of CSS classes available to the page.

    • cssId, which indicates a list of CSS selector ID rules available to the page.

Contents

None.

Container

The parammenu tag of type optionArray.