M

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

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)

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
)

Autodesk.Revit.DB.Units

units

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

specTypeId

Identifier of the target spec for the value.
String

stringToParse

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

valueParsingOptions

Additional parsing options.
Double%

value

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

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

Autodesk.Revit.Exceptions.ArgumentException

specTypeId is not a spec identifier. See UnitUtils.IsSpec(ForgeTypeId) and UnitUtils.GetSpecTypeId(UnitType). -or- The unit in the FormatOptions in valueParsingOptions is not a valid unit for specTypeId. See UnitUtils.IsValidUnit(ForgeTypeId, ForgeTypeId) and UnitUtils.GetValidUnits(ForgeTypeId).
Autodesk.Revit.Exceptions.ArgumentNullException

A non-optional argument was NULL

Share a snippet Help the community

Loading…

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

Syntax

Parameters

Exceptions

Community Snippets

Discussion … comments