DOCUMENTATION CENTER SEARCH

New to Mathematica? Find your learning path »

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

BUILT-IN MATHEMATICA SYMBOL

Tutorials »|See Also »|More About »

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.

MORE INFORMATION

OptionValue gives explicit forms for default option values.

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.

Basic Examples (1)

Define default option values for the function

:

Define

, allowing options to be given:

Use

with an explicit option setting:

Use

with options taken to have their default values:

Define default option values for the function

:

Define

, allowing options to be given:

Use

with an explicit option setting:

Out[3]=

Use

with options taken to have their default values:

Out[4]=

OptionsPattern Options AbsoluteOptions FilterRules

Setting Up Functions with Optional Arguments

Manipulating Options

Options Management

Package Development

New in 6.0: Core Language

New in 6

Ask a question about this page | Suggest an improvement | Leave a message for the team

Format: HTML | CDF