DOCUMENTATION CENTER SEARCH

Mathematica > Options Management >

Built-in Mathematica Symbol

Tutorials »|See Also »|More About »

OptionValue

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

OptionValue[f, name]
gives the value of name for options associated with the head f.

OptionValue[f, opts, name]
extracts option values from the explicit list of rules opts.

MORE INFORMATION

OptionValue[{opt₁->val₁, ...}, ...] gives explicit forms for default option values.

OptionValue[{spec₁, spec₂, ...}, ...] allows either f_i or opt_i->val_i as specifications of default option values. Each head is treated as the list of rules obtained from Options[f_i].

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

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

OptionValue[f, name]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 f:

Define f, allowing options to be given:

Use f with an explicit option setting:

Use f with options taken to have their default values:

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

© 2008 Wolfram Research, Inc.

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