M

UnitUtils.Convert(Double, DisplayUnitType, DisplayUnitType)

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

Overloads (2):

Convert(Double,DisplayUnitType,DisplayUnitType)

[ObsoleteAttribute("This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `Convert(double, ForgeTypeId, ForgeTypeId)` overload instead.")]
public static double Convert(
	double value,
	DisplayUnitType currentDisplayUnit,
	DisplayUnitType desiredDisplayUnit
)

<ObsoleteAttribute("This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `Convert(double, ForgeTypeId, ForgeTypeId)` overload instead.")> _
Public Shared Function Convert ( _
	value As Double, _
	currentDisplayUnit As DisplayUnitType, _
	desiredDisplayUnit As DisplayUnitType _
) As Double

[ObsoleteAttribute(L"This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `Convert(double, ForgeTypeId, ForgeTypeId)` overload instead.")]
public:
static double Convert(
	double value, 
	DisplayUnitType currentDisplayUnit, 
	DisplayUnitType desiredDisplayUnit
)

Double

value

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

currentDisplayUnit

The current display unit.
Autodesk.Revit.DB.DisplayUnitType

desiredDisplayUnit

The desired display unit.

Return Value The converted value. The converted value.

void SetTopOffset(Wall wall, double dOffsetInches)
{
    // convert user-defined offset value to feet from inches prior to setting
    double dOffsetFeet = UnitUtils.Convert(dOffsetInches, 
                                            DisplayUnitType.DUT_DECIMAL_INCHES, 
                                            DisplayUnitType.DUT_DECIMAL_FEET);

    Parameter paramTopOffset = wall.get_Parameter(BuiltInParameter.WALL_TOP_OFFSET);
    paramTopOffset.Set(dOffsetFeet);
}

Private Sub SetTopOffset(wall As Wall, dOffsetInches As Double)
   ' convert user-defined offset value to feet from inches prior to setting
   Dim dOffsetFeet As Double = UnitUtils.Convert(dOffsetInches, DisplayUnitType.DUT_DECIMAL_INCHES, DisplayUnitType.DUT_DECIMAL_FEET)

   Dim paramTopOffset As Parameter = wall.Parameter(BuiltInParameter.WALL_TOP_OFFSET)
   paramTopOffset.[Set](dOffsetFeet)
End Sub

Autodesk.Revit.Exceptions.ArgumentException

The given value for value is not finite -or- currentDisplayUnit is an invalid display unit. See UnitUtils.IsValidDisplayUnit(DisplayUnitType) and UnitUtils.GetValidDisplayUnits(). -or- desiredDisplayUnit is an invalid display unit. See UnitUtils.IsValidDisplayUnit(DisplayUnitType) and UnitUtils.GetValidDisplayUnits().
Autodesk.Revit.Exceptions.ArgumentOutOfRangeException

A value passed for an enumeration argument is not a member of that enumeration
Autodesk.Revit.Exceptions.ArgumentsInconsistentException

currentDisplayUnit and desiredDisplayUnit have different dimensions.

Share a snippet Help the community

Loading…

UnitUtils.Convert(Double, DisplayUnitType, DisplayUnitType)

Syntax

Parameters

Examples (from Revit 2020)

Exceptions

Community Snippets

Discussion … comments