Parses a formatted string into a number with units if possible.
Namespace:
Autodesk.Revit.DB
Assembly:
RevitAPI
(in RevitAPI.dll) Version: 21.0.0.0 (21.1.1.109)
Since:
2014
Syntax
C# |
---|
|
Visual Basic |
---|
|
Visual C++ |
---|
|
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 target spec for the value.
- stringToParse
-
Type:
System
String
The string to parse.
- valueParsingOptions
-
Type:
Autodesk.Revit.DB
ValueParsingOptions
Additional parsing options.
- value
-
Type:
System
Double
%
The parsed value. Ignore this value if the function returns false.
Return Value
True if the string can be parsed, false otherwise.Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.Exceptions ArgumentException | specTypeId is not a spec identifier. See UnitUtils.IsSpec(ForgeTypeId) and UnitUtils.GetSpecTypeId(UnitType). -or- The unit in the FormatOptions in valueParsingOptions is not a valid unit for specTypeId. See UnitUtils.IsValidUnit(ForgeTypeId, ForgeTypeId) and UnitUtils.GetValidUnits(ForgeTypeId). |
Autodesk.Revit.Exceptions ArgumentNullException | A non-optional argument was NULL |