Namespace: Autodesk.Revit.DB Class: UnitFormatUtils

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

Method

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

Syntax

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

Public Shared Function TryParse ( 
	units As Units,
	specTypeId As ForgeTypeId,
	stringToParse As String,
	valueParsingOptions As ValueParsingOptions,
	<OutAttribute> ByRef value As Double
) As Boolean

public:
static bool TryParse(
	Units^ units, 
	ForgeTypeId^ specTypeId, 
	String^ stringToParse, 
	ValueParsingOptions^ valueParsingOptions, 
	[OutAttribute] double% value
)

static member TryParse : 
        units : Units * 
        specTypeId : ForgeTypeId * 
        stringToParse : string * 
        valueParsingOptions : ValueParsingOptions * 
        value : float byref -> bool

Parameters

Parameter	Type	Description
units	Units	The units formatting settings, typically obtained from <a href="9ed56178-e9ae-b4bc-1c0e-e6a867ae3557.htm">Document.GetUnits()</a>.
specTypeId	ForgeTypeId	Identifier of the target spec for the value.
stringToParse	String	The string to parse.
valueParsingOptions	ValueParsingOptions	Additional parsing options.
value	Double	The parsed value. Ignore this value if the function returns false.

Return Value

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

Exceptions

Exception	Condition
ArgumentException	specTypeId is not a measurable spec identifier. See UnitUtils.IsMeasurableSpec(ForgeTypeId). -or- The unit in the FormatOptions in valueParsingOptions is not a valid unit for specTypeId. See UnitUtils.IsValidUnit(ForgeTypeId, ForgeTypeId) and UnitUtils.GetValidUnits(ForgeTypeId).
ArgumentNullException	A non-optional argument was null