M

UnitUtils.Convert

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

public static double Convert(
	double value,
	ForgeTypeId currentUnitTypeId,
	ForgeTypeId desiredUnitTypeId
)

Public Shared Function Convert ( _
	value As Double, _
	currentUnitTypeId As ForgeTypeId, _
	desiredUnitTypeId As ForgeTypeId _
) As Double

public:
static double Convert(
	double value, 
	ForgeTypeId^ currentUnitTypeId, 
	ForgeTypeId^ desiredUnitTypeId
)

Double

value

The value to convert.
Autodesk.Revit.DB.ForgeTypeId

currentUnitTypeId

Identifier of the current unit.
Autodesk.Revit.DB.ForgeTypeId

desiredUnitTypeId

Identifier of the desired unit.

Return Value The converted value. The converted value.

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.

Loading…

Syntax