THIS IS DOCUMENTATION FOR AN OBSOLETE PRODUCT.
SEE THE DOCUMENTATION CENTER FOR THE LATEST INFORMATION.

DOCUMENTATION CENTER SEARCH

Mathematica > Core Language > Package Development > Options Management > OptionValue >

BUILT-IN MATHEMATICA SYMBOL

OptionValue

OptionValue[name]
gives the value of name in options matched by OptionsPattern.

gives the value of name for options associated with the head f.

extracts option values from the explicit list of rules opts.

OptionValue allows either or as specifications of default option values. Each head is treated as the list of rules obtained from Options.

OptionValue uses the match for the first OptionsPattern object that appears as an argument of f.

OptionValue[name] is equivalent to OptionValue, where f is the head of the left-hand side of the transformation rule in which OptionValue[name] appears.

OptionValue and OptionValue[name] always first use option values obtained from an explicit match for an OptionsPattern, then use defaults specified by Options[f].

OptionValue[f, opts, name, Hold] returns the option value with Hold wrapped around it.

OptionValue[Automatic, Automatic, name, Hold] is equivalent to OptionValue[name], except that the option value is returned with Hold wrapped around it.