Parses a formatted string into a number with units if possible.
Namespace: Autodesk.Revit.DBAssembly: RevitAPI (in RevitAPI.dll) Version: 21.0.0.0 (21.1.1.109)
Since:
2014
Syntax
| C# |
|---|
[ObsoleteAttribute("This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `TryParse(Units, ForgeTypeId, string, out double, out string)` overload instead.")]
public static bool TryParse(
Units units,
UnitType unitType,
string stringToParse,
out double value,
out string message
) |
| Visual Basic |
|---|
<ObsoleteAttribute("This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `TryParse(Units, ForgeTypeId, string, out double, out string)` overload instead.")> _
Public Shared Function TryParse ( _
units As Units, _
unitType As UnitType, _
stringToParse As String, _
<OutAttribute> ByRef value As Double, _
<OutAttribute> ByRef message As String _
) As Boolean |
| Visual C++ |
|---|
[ObsoleteAttribute(L"This method is deprecated in Revit 2021 and may be removed in a future version of Revit. Please use the `TryParse(Units, ForgeTypeId, string, out double, out string)` overload instead.")]
public:
static bool TryParse(
Units^ units,
UnitType unitType,
String^ stringToParse,
[OutAttribute] double% value,
[OutAttribute] String^% message
) |
Parameters
- units
- Type: Autodesk.Revit.DB..::..Units
The units formatting settings, typically obtained from Document.GetUnits().
- unitType
- Type: Autodesk.Revit.DB..::..UnitType
The target unit type for the value.
- stringToParse
- Type: System..::..String
The string to parse.
- value
- Type: System..::..Double%
The parsed value, in Revit's internal units. Ignore this value if the function returns false.
- message
- Type: System..::..String%
A localized message that, if the parsing fails, explains the reason for failure.
Return Value
True if the string can be parsed, false otherwise.
Exceptions
See Also
