M

UnitFormatUtils.TryParse

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

Overloads (4):

TryParse

TryParse(Units,ForgeTypeId,String,Double)

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

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

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

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

Units

units

The units formatting settings, typically obtained from Document.GetUnits().
ForgeTypeId

specTypeId

Identifier of the target spec for the value.
String

stringToParse

The string to parse.
ValueParsingOptions

valueParsingOptions

Additional parsing options.
Double%

value

The parsed value. Ignore this value if the function returns false.

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

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