M

UnitFormatUtils.TryParse

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

Overloads (8):

TryParse(Units,ForgeTypeId,String,Double)

TryParse(Units,ForgeTypeId,String,Double,String)

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

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

TryParse(Units,UnitType,String,Double)

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

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

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

[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, ValueParsingOptions, out double, out string)` overload instead.")]
public static bool TryParse(
	Units units,
	UnitType unitType,
	string stringToParse,
	ValueParsingOptions valueParsingOptions,
	out double value,
	out string message
)

<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, ValueParsingOptions, out double, out string)` overload instead.")> _
Public Shared Function TryParse ( _
	units As Units, _
	unitType As UnitType, _
	stringToParse As String, _
	valueParsingOptions As ValueParsingOptions, _
	<OutAttribute> ByRef value As Double, _
	<OutAttribute> ByRef message As String _
) As Boolean

[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, ValueParsingOptions, out double, out string)` overload instead.")]
public:
static bool TryParse(
	Units^ units, 
	UnitType unitType, 
	String^ stringToParse, 
	ValueParsingOptions^ valueParsingOptions, 
	[OutAttribute] double% value, 
	[OutAttribute] String^% message
)

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.
String

stringToParse

The string to parse.
Autodesk.Revit.DB.ValueParsingOptions

valueParsingOptions

Additional parsing options.
Double%

value

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

message

A localized message that, if the parsing fails, explains the reason for failure.

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

Autodesk.Revit.Exceptions.ArgumentException

unitType is an invalid unit type. See UnitUtils.IsValidUnitType() and UnitUtils.GetValidUnitTypes(). -or- The display unit in the FormatOptions in valueParsingOptions 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