Sign in
2021 Method
Changes 8
M

UnitFormatUtils.Format

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
)
  • 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.