Parameter.Set(Double)

Public Class

Sets the parameter to a new real number value.

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public bool Set(
  double value
)

Parameters

valueDouble

The new double value to which the parameter is to be set.

Return Value

Boolean
The Set method will return True if the parameter was successfully set to the new value, otherwise false.

Exceptions

Exception

Condition

InvalidOperationException

The parameter is read-only.

ArgumentException

Value must be a finite number.

Remarks

You should only use this method if the StorageType property reports the type of the parameter as a Double.

Example

public bool SetParameter(Parameter parameter, double value)
{
    bool result = false;
    //if the parameter is readonly, you can�t change the value of it
    if (null != parameter && !parameter.IsReadOnly)
    {
        StorageType parameterType = parameter.StorageType;
        if (StorageType.Double != parameterType)
        {
            throw new Exception("The storagetypes of value and parameter are different!");
        }
        //If successful, the result is true
        result = parameter.Set(value);
    }

    return result;
}