Namespace: Autodesk.Revit.DB Class: UnitFormatUtils

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

Method

Description:
Formats a number with units into a string.

Syntax

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

Public Shared Function Format ( 
	units As Units,
	specTypeId As ForgeTypeId,
	value As Double,
	forEditing As Boolean,
	formatValueOptions As FormatValueOptions
) As String

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

static member Format : 
        units : Units * 
        specTypeId : ForgeTypeId * 
        value : float * 
        forEditing : bool * 
        formatValueOptions : FormatValueOptions -> string

Parameters

Parameter	Type	Description
units	Units	The units formatting settings, typically obtained from <a href="9ed56178-e9ae-b4bc-1c0e-e6a867ae3557.htm">Document.GetUnits()</a>.
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.

Return Value

Type	Description
String	The formatted string.

Exceptions

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