UnitFormatUtils.Format(Units, ForgeTypeId, Double, Boolean, FormatValueOptions) Method

Formats a number with units into a string.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 26.2.0.0 (26.2.0.0)

Syntax

public static string Format(
	Units units,
	ForgeTypeId specTypeId,
	double value,
	bool forEditing,
	FormatValueOptions formatValueOptions
)

units Units: The units formatting settings, typically obtained from Document.GetUnits().
specTypeId ForgeTypeId: Identifier of the spec of the value to format.
value Double: The value to format, in Revit's internal units.
forEditing Boolean: 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.
formatValueOptions FormatValueOptions: Additional formatting options.

String
The formatted string.

Exception	Condition
ArgumentException	specTypeId is not a measurable spec identifier. See UnitUtils.IsMeasurableSpec(ForgeTypeId). -or- The given value for value is not finite -or- The unit in the FormatOptions in formatValueOptions is not a valid unit for specTypeId. See UnitUtils.IsValidUnit(ForgeTypeId, ForgeTypeId) and UnitUtils.GetValidUnits(ForgeTypeId).
ArgumentNullException	A non-optional argument was null