M

UnitFormatUtils.Format

Description:
Formats a number with units into a string.

Overloads (2):

Format

Format(Units,ForgeTypeId,Double,Boolean)

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

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

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

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

Units

units

The units formatting settings, typically obtained from Document.GetUnits().
ForgeTypeId

specTypeId

Identifier of the spec 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 String The formatted string.

ArgumentException

specTypeId is not a measurable spec identifier. See UnitUtils.IsMeasurableSpec(ForgeTypeId). -or- The given value for value is not finite
ArgumentNullException

A non-optional argument was null