Share

UnitFormatUtils.TryParse(Units, ForgeTypeId, String, Double, String) Method

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


Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 26.2.0.0 (26.2.0.0)

Syntax

C#

public static bool TryParse(
	Units units,
	ForgeTypeId specTypeId,
	string stringToParse,
	out double value,
	out string message
)

Parameters

units  Units
The units formatting settings, typically obtained from Document.GetUnits().
specTypeId  ForgeTypeId
Identifier of the target spec for the value.
stringToParse  String
The string to parse.
value  Double%
The parsed value. Ignore this value if the function returns false.
message  String%
A localized message that, if the parsing fails, explains the reason for failure.

Return Value

Boolean
True if the string can be parsed, false otherwise.

Exceptions

ExceptionCondition
ArgumentException specTypeId is not a measurable spec identifier. See UnitUtils.IsMeasurableSpec(ForgeTypeId).
ArgumentNullException A non-optional argument was null

See Also

Reference

Was this information helpful?