M

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

Description:
Formats a number with units into a string.

Overloads (2):

Format(Units,UnitType,Double,Boolean,Boolean)

Format(Units,UnitType,Double,Boolean,Boolean,FormatValueOptions)

public static string Format(
	Units units,
	UnitType unitType,
	double value,
	bool maxAccuracy,
	bool forEditing,
	FormatValueOptions formatValueOptions
)

Public Shared Function Format ( _
	units As Units, _
	unitType As UnitType, _
	value As Double, _
	maxAccuracy As Boolean, _
	forEditing As Boolean, _
	formatValueOptions As FormatValueOptions _
) As String

public:
static String^ Format(
	Units^ units, 
	UnitType unitType, 
	double value, 
	bool maxAccuracy, 
	bool forEditing, 
	FormatValueOptions^ formatValueOptions
)

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.
System.Double

value

The value to format, in Revit's internal units.
System.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.
System.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.
Autodesk.Revit.DB.FormatValueOptions

formatValueOptions

Additional formatting options.

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 -or- The display unit in the FormatOptions in formatValueOptions is not a valid display unit for unitType. See UnitUtils.IsValidDisplayUnit(UnitType, DisplayUnitType) and UnitUtils.GetValidDisplayUnits(UnitType).
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

Share a snippet Help the community

Loading…

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

Syntax

Parameters

Exceptions

Community Snippets

Discussion … comments