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 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, _
	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 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

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.

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