M

UnitFormatUtils.TryParse

Description:
Parses a formatted string into a number with units if possible.

Overloads (4):

TryParse(Units,UnitType,String,Double)

TryParse(Units,UnitType,String,Double,String)

TryParse(Units,UnitType,String,ValueParsingOptions,Double)

TryParse(Units,UnitType,String,ValueParsingOptions,Double,String)

public static bool TryParse(
	Units units,
	UnitType unitType,
	string stringToParse,
	out double value
)

Public Shared Function TryParse ( _
	units As Units, _
	unitType As UnitType, _
	stringToParse As String, _
	<OutAttribute> ByRef value As Double _
) As Boolean

public:
static bool TryParse(
	Units^ units, 
	UnitType unitType, 
	String^ stringToParse, 
	[OutAttribute] double% value
)

Autodesk.Revit.DB.Units

units

The units formatting settings, typically obtained from Document.GetUnits().
Autodesk.Revit.DB.UnitType

unitType

The target unit type for the value.
System.String

stringToParse

The string to parse.
System.Double%

value

The parsed value, in Revit's internal units. Ignore this value if the function returns false.

Return Value bool True if the string can be parsed, false otherwise.

double GetLengthInput(Document document, String userInputLength)
{
    double dParsedLength = 0;
    Units units = document.GetUnits();
    // try to parse a user entered string (i.e. 100 mm, 1'6")
    bool parsed = UnitFormatUtils.TryParse(units, UnitType.UT_Length, userInputLength, out dParsedLength);
    if (parsed == true)
    {
        string msg = string.Format("User Input: {0}\r\nParsed value: {1}", userInputLength, dParsedLength);
        TaskDialog.Show("Parsed Data", msg);
    }

    return dParsedLength;
}

Private Function GetLengthInput(document As Document, userInputLength As [String]) As Double
   Dim dParsedLength As Double = 0
   Dim units As Units = document.GetUnits()
   ' try to parse a user entered string (i.e. 100 mm, 1'6")
   Dim parsed As Boolean = UnitFormatUtils.TryParse(units, UnitType.UT_Length, userInputLength, dParsedLength)
   If parsed = True Then
      Dim msg As String = String.Format("User Input: {0}" & vbCr & vbLf & "Parsed value: {1}", userInputLength, dParsedLength)
      TaskDialog.Show("Parsed Data", msg)
   End If

   Return dParsedLength
End Function

Autodesk.Revit.Exceptions.ArgumentException

unitType is an invalid unit type. See UnitUtils.IsValidUnitType() and UnitUtils.GetValidUnitTypes().
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