•  

Convert Method (Double, ForgeTypeId, ForgeTypeId)

Converts a value from one unit to another, such as square feet to square meters.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 22.0.0.0 (22.1.0.0)
Since: 2014

Syntax

C# 
public static double Convert(
	double value,
	ForgeTypeId currentUnitTypeId,
	ForgeTypeId desiredUnitTypeId
)
Visual Basic 
Public Shared Function Convert ( _
	value As Double, _
	currentUnitTypeId As ForgeTypeId, _
	desiredUnitTypeId As ForgeTypeId _
) As Double
Visual C++ 
public:
static double Convert(
	double value, 
	ForgeTypeId^ currentUnitTypeId, 
	ForgeTypeId^ desiredUnitTypeId
)

Parameters

value
Type: System Double
The value to convert.
currentUnitTypeId
Type: Autodesk.Revit.DB ForgeTypeId
Identifier of the current unit.
desiredUnitTypeId
Type: Autodesk.Revit.DB ForgeTypeId
Identifier of the desired unit.

Return Value

The converted value.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentException The given value for value is not finite -or- currentUnitTypeId is not a unit identifier. See UnitUtils.IsUnit(ForgeTypeId) and UnitUtils.GetUnitTypeId(DisplayUnitType). -or- desiredUnitTypeId is not a unit identifier. See UnitUtils.IsUnit(ForgeTypeId) and UnitUtils.GetUnitTypeId(DisplayUnitType).
Autodesk.Revit.Exceptions ArgumentNullException A non-optional argument was null
Autodesk.Revit.Exceptions ArgumentsInconsistentException currentUnitTypeId and desiredUnitTypeId have different dimensions.

See Also

ArchiLabs

Stop fighting Revit automation.

Build repeatable BIM design and documentation workflows with scripts, data, and AI in one place, without wrestling brittle one-off automations.

Try ArchiLabs →