This is the most recent version of Tekla Open API.
For older versions, please visit Tekla Warehouse.

DistanceFromDecimalString Method (String, IFormatProvider, DistanceUnitType)

Creates a distance from a decimal string representation.

Namespace: Tekla.Structures.Datatype
Assembly: Tekla.Structures.Datatype (in Tekla.Structures.Datatype.dll) Version: 2023.0.1

Syntax

Copy

public static Distance FromDecimalString(
	string text,
	IFormatProvider formatProvider,
	DistanceUnitType unitType
)

Public Shared Function FromDecimalString ( 
	text As String,
	formatProvider As IFormatProvider,
	unitType As DistanceUnitType
) As Distance

Parameters

text: Type: SystemString
The distance string.
formatProvider: Type: SystemIFormatProvider
The number format provider.
unitType: Type: Tekla.Structures.DatatypeDistanceUnitType
The unit type of the distance to parse.

Return Value

Type: Distance
The representation of the specified distance.

Exceptions

Exception	Condition
FormatException	Thrown if the text does not represent a distance.
ArgumentException	Thrown if an invalid unit type is specified.

Examples

This example shows how to specify a format provider and a unit type when parsing a Distance instance from a decimal string.

Copy

using Tekla.Structures.Datatype;
using System.Globalization;

public class Example
{
       public void Example1()
       {
           Distance distance = Distance.FromDecimalString("3.2", CultureInfo.InvariantCulture, Distance.UnitType.Inch);
       }
}

Reference

Distance Structure

FromDecimalString Overload

Tekla.Structures.Datatype Namespace

API Reference

DistanceAddLanguageSpecificTextSet("LST62766832_0?cpp=::|nu=.");FromDecimalString Method (String, IFormatProvider, DistanceAddLanguageSpecificTextSet("LST62766832_1?cpp=::|nu=.");UnitType)

Parameters

Return Value

Reference

DistanceFromDecimalString Method (String, IFormatProvider, DistanceUnitType)