FormIt.StringConversion API

Description

Functions
json	FormIt.StringConversion.LinearValueToString (val, forceImperialFeetInchesOrMeter, bMaintainUnitType, includeUnitsAndThousandsSeparators, decimalPlaces)
	Convert a linear value to a string.
json	FormIt.StringConversion.StringToLinearValue (val, forceFeetOrMeter, bMaintainUnitType)
	Convert a string to a linear value.
json	FormIt.StringConversion.AreaValueToString (val, forceFeetOrMeter)
	AreaValueToString converts an area value to a string Parameters: In: val In: forceFeetOrMeter Out: { unitValue }
json	FormIt.StringConversion.StringToAreaValue (val, forceFeetOrMeter, bMaintainUnitType)
	StringToAreaValue converts a string to an area value If bMaintainUnitType is true, the value will be in the units of the model.
json	FormIt.StringConversion.VolumeValueToString (val, forceFeetOrMeter)
	VolumeValueToString converts a volume value to a string Parameters: In: val In: forceFeetOrMeter Out: { unitValue }
json	FormIt.StringConversion.StringToVolumeValue (val, forceFeetOrMeter, bMaintainUnitType)
	StringToVolumeValue converts a string to a volume value If bMaintainUnitType is true, the value will be in the units of the model.

Function Documentation

AreaValueToString()

json FormIt.StringConversion.AreaValueToString	(	val	,
		forceFeetOrMeter
	)

AreaValueToString converts an area value to a string Parameters: In: val In: forceFeetOrMeter Out: { unitValue }

Parameters

[in]	val	double
[in]	forceFeetOrMeter	(OPTIONAL, default = false) bool

Returns

unitValue

LinearValueToString()

json FormIt.StringConversion.LinearValueToString	(	val	,
		forceImperialFeetInchesOrMeter	,
		bMaintainUnitType	,
		includeUnitsAndThousandsSeparators	,
		decimalPlaces
	)

Convert a linear value to a string.

If forceFeetOrMeter is true, the string will

always be formatted as feet or meter If bMaintainUnitType is true, the value will be in the units of the model. NOTE: FormIt will set the current units based off the loaded model using FormIt.Model.SetUnitTypeCurrent Parameters: In: val forceImperialFeetInchesOrMeter (optional, default is false) bMaintainUnitType (optional, default is false) includeUnitsAndThousandsSeparators (optional, default is true) decimalPlaces (options, default is 2) Out: { unitValue }

Parameters

[in]	val	double
[in]	forceImperialFeetInchesOrMeter	(OPTIONAL, default = false) bool
[in]	bMaintainUnitType	(OPTIONAL, default = false) bool
[in]	includeUnitsAndThousandsSeparators	(OPTIONAL, default = true) bool
[in]	decimalPlaces	(OPTIONAL, default = 2) unsigned int

Returns

valStr

StringToAreaValue()

json FormIt.StringConversion.StringToAreaValue	(	val	,
		forceFeetOrMeter	,
		bMaintainUnitType
	)

StringToAreaValue converts a string to an area value If bMaintainUnitType is true, the value will be in the units of the model.

Parameters: In: val In: forceFeetOrMeter (optional, default is false), bMaintainUnitType (optional, default is false) Out: { success: result: }

Parameters

[in]	val	String
[in]	forceFeetOrMeter	(OPTIONAL, default = false) bool
[in]	bMaintainUnitType	(OPTIONAL, default = false) bool

Returns

{...}

StringToLinearValue()

json FormIt.StringConversion.StringToLinearValue	(	val	,
		forceFeetOrMeter	,
		bMaintainUnitType
	)

Convert a string to a linear value.

If forceImperialFeetInchesOrMeter is true, the value will always be interpreted as feet or meter, unless it contains an explicit unit. If bMaintainUnitType is true, the value will be in the units of the model. For example "2" will be 2 feet, whereas "2 in" will remain 2 inches Returns true in the pair first, if successful, and the converted value in the pair second NOTE: FormIt will set the current units based off the loaded model using FormIt.Model.SetUnitTypeCurrent Parameters: In: val In: forceFeetOrMeter (optional, default is false), bMaintainUnitType (optional, default is false) Out: { success: result: }

Parameters

[in]	val	String
[in]	forceFeetOrMeter	(OPTIONAL, default = false) bool
[in]	bMaintainUnitType	(OPTIONAL, default = false) bool

Returns

{...}

StringToVolumeValue()

json FormIt.StringConversion.StringToVolumeValue	(	val	,
		forceFeetOrMeter	,
		bMaintainUnitType
	)

StringToVolumeValue converts a string to a volume value If bMaintainUnitType is true, the value will be in the units of the model.

Parameters: In: val In: forceFeetOrMeter (optional, default is false), bMaintainUnitType (optional, default is false) Out: { success: result: }

Parameters

[in]	val	String
[in]	forceFeetOrMeter	(OPTIONAL, default = false) bool
[in]	bMaintainUnitType	(OPTIONAL, default = false) bool

Returns

{...}

VolumeValueToString()

json FormIt.StringConversion.VolumeValueToString	(	val	,
		forceFeetOrMeter
	)

VolumeValueToString converts a volume value to a string Parameters: In: val In: forceFeetOrMeter Out: { unitValue }

Parameters

[in]	val	double
[in]	forceFeetOrMeter	(OPTIONAL, default = false) bool

Returns

unitValue