M

UnitFormatUtils.Format(Units, UnitType, Double, Boolean, Boolean)

Description:
Formats a number with units into a string.

Overloads (6):

Format(Units,ForgeTypeId,Double,Boolean)

Format(Units,ForgeTypeId,Double,Boolean,FormatValueOptions)

Format(Units,UnitType,Double,Boolean)

Format(Units,UnitType,Double,Boolean,Boolean)

Format(Units,UnitType,Double,Boolean,Boolean,FormatValueOptions)

Format(Units,UnitType,Double,Boolean,FormatValueOptions)

[ObsoleteAttribute("This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `Format(Units, ForgeTypeId, double, bool)` overload instead.")]
public static string Format(
	Units units,
	UnitType unitType,
	double value,
	bool maxAccuracy,
	bool forEditing
)

<ObsoleteAttribute("This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `Format(Units, ForgeTypeId, double, bool)` overload instead.")> _
Public Shared Function Format ( _
	units As Units, _
	unitType As UnitType, _
	value As Double, _
	maxAccuracy As Boolean, _
	forEditing As Boolean _
) As String

[ObsoleteAttribute(L"This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `Format(Units, ForgeTypeId, double, bool)` overload instead.")]
public:
static String^ Format(
	Units^ units, 
	UnitType unitType, 
	double value, 
	bool maxAccuracy, 
	bool forEditing
)

Autodesk.Revit.DB.Units

units

The units formatting settings, typically obtained from Document.GetUnits().
Autodesk.Revit.DB.UnitType

unitType

The unit type of the value to format.
Double

value

The value to format, in Revit's internal units.
Boolean

maxAccuracy

True if the value should be rounded to an increased accuracy level appropriate for editing or understanding the precise value stored in the model. False if the accuracy specified by the FormatOptions should be used, appropriate for printed drawings.
Boolean

forEditing

True if the formatting should be modified as necessary so that the formatted string can be successfully parsed, for example by suppressing digit grouping. False if unmodified settings should be used, suitable for display only.

Return Value The formatted string. The formatted string.

void DisplayDensityOfMaterial(Material material)
{
    double density = 0;
    // get structural asset of material in order to get the density
    ElementId strucAssetId = material.StructuralAssetId;
    if (strucAssetId != ElementId.InvalidElementId)
    {
        PropertySetElement pse = material.Document.GetElement(strucAssetId) as PropertySetElement;
        if (pse != null)
        {
            StructuralAsset asset = pse.GetStructuralAsset();

            density = asset.Density;
            // convert the density value to a user readable string that includes the units
            Units units = material.Document.GetUnits();
            // false for maxAccuracy means accuracy specified by the FormatOptions should be used
            // false for forEditing since this will be for display only and no formatting modifications are necessary
            string strDensity = UnitFormatUtils.Format(units, UnitType.UT_UnitWeight, density, false, false);
            string msg = string.Format("Raw Value: {0}\r\nFormatted Value: {1}", density, strDensity);
            TaskDialog.Show("Material Density", msg);
        }
    }
}

Private Sub DisplayDensityOfMaterial(material As Material)
   Dim density As Double = 0
   ' get structural asset of material in order to get the density
   Dim strucAssetId As ElementId = material.StructuralAssetId
   If strucAssetId <> ElementId.InvalidElementId Then
      Dim pse As PropertySetElement = TryCast(material.Document.GetElement(strucAssetId), PropertySetElement)
      If pse IsNot Nothing Then
         Dim asset As StructuralAsset = pse.GetStructuralAsset()

         density = asset.Density
         ' convert the density value to a user readable string that includes the units
         Dim units As Units = material.Document.GetUnits()
         ' false for maxAccuracy means accuracy specified by the FormatOptions should be used
         ' false for forEditing since this will be for display only and no formatting modifications are necessary
         Dim strDensity As String = UnitFormatUtils.Format(units, UnitType.UT_UnitWeight, density, False, False)
         Dim msg As String = String.Format("Raw Value: {0}" & vbCr & vbLf & "Formatted Value: {1}", density, strDensity)
         TaskDialog.Show("Material Density", msg)
      End If
   End If
End Sub

Autodesk.Revit.Exceptions.ArgumentException

unitType is an invalid unit type. See UnitUtils.IsValidUnitType() and UnitUtils.GetValidUnitTypes(). -or- The given value for value is not finite
Autodesk.Revit.Exceptions.ArgumentNullException

A non-optional argument was NULL
Autodesk.Revit.Exceptions.ArgumentOutOfRangeException

A value passed for an enumeration argument is not a member of that enumeration

Oct 15, 2026

1 2 3 4 5 6 7 8 9 10 11 12 13 14

using Autodesk.Revit.DB;

public static bool TryReadFabricationSlopeByBuiltInParameter(
    FabricationPart part,
    out double rawSlope,
    out string formattedSlope)
{
    // Lookup by the BuiltInParameter for Fabrication Slope.
    return TryReadFabricationSlope(
        part,
        part.get_Parameter(BuiltInParameter.FABRICATION_SLOPE_PARAM),
        out rawSlope,
        out formattedSlope);
}

FabricationPart Slope Bug

The Slope parameter for FabricationPart is incorrectly assigned SpecTypeId.Slope instead …

@martin

👍 0 8

Share a snippet Help the community

Loading…

UnitFormatUtils.Format(Units, UnitType, Double, Boolean, Boolean)

Syntax

Parameters

Examples (from Revit 2020)

Exceptions

Community Snippets

Discussion … comments