Parameter.SuggestedMax operator

Introduced

v3.0

Description

Returns the suggested maximum value (Variant) for the parameter. A parameter can have two separate ranges: the Min/Max which defines the entire range of legal values; and the Suggested Minimum/Suggested Maximum which defines a sub-range of the Min/Max that make the most sense.

For example, an enormous number of subdivisions may theoretically be possible on a geometry, but for performance reasons a smaller range can be suggested to the user. The Suggested Min/Max values are used when determining the slider ranges for controls when parameters are inspected.

This property is only valid for numeric parameters. Other variant types, for example siString (see siVariantType) do not have the concept of Minimum or Maximum.

C# Syntax

// get accessor
Object rtn = Parameter.SuggestedMax;

See Also

Parameter.SuggestedMin Parameter.Min Parameter.Max CustomProperty.AddParameter siVariantType