Formats a number with units into a string.
Namespace: Autodesk.Revit.DBAssembly: RevitAPI (in RevitAPI.dll) Version: 23.0.0.0 (23.1.0.0)
Since:
2014
Syntax
| C# |
|---|
public static string Format(
Units units,
ForgeTypeId specTypeId,
double value,
bool forEditing
) |
| Visual Basic |
|---|
Public Shared Function Format ( _
units As Units, _
specTypeId As ForgeTypeId, _
value As Double, _
forEditing As Boolean _
) As String |
| Visual C++ |
|---|
public:
static String^ Format(
Units^ units,
ForgeTypeId^ specTypeId,
double value,
bool forEditing
) |
Parameters
- units
- Type: Autodesk.Revit.DB..::..Units
The units formatting settings, typically obtained from Document.GetUnits().
- specTypeId
- Type: Autodesk.Revit.DB..::..ForgeTypeId
Identifier of the spec of the value to format.
- value
- Type: System..::..Double
The value to format, in Revit's internal units.
- forEditing
- Type: System..::..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.
Return Value
The formatted string.
Exceptions
See Also
