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,
	out double value,
	out string message
)

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

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

static member TryParse : 
        units : Units * 
        specTypeId : ForgeTypeId * 
        stringToParse : string * 
        value : float byref * 
        message : string 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.
Double%

value

The parsed value. 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 Boolean True if the string can be parsed, false otherwise.

ArgumentException

specTypeId is not a measurable spec identifier. See UnitUtils.IsMeasurableSpec(ForgeTypeId).
ArgumentNullException

A non-optional argument was null