Convert Method (UnitClassProperty)

In This Topic

Convert a property to the specified unit.

Syntax

public virtual void Convert( 
   Unit unit
)

Parameters

unit: The unit to convert to.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.WrongUnitException	Thrown when the unit is not valid for this property.

Remarks

If the property holds a string value set by the user (e.g. a fraction value), this method deletes this value.

Example

The following example shows how to convert values from one unit to another. For example convert the LengthProperty value, which is in meters, to millimeters.

LengthProperty lengthProperty = "5 m";
lengthProperty.Convert(Unit.Millimeter);
Console.WriteLine(lengthProperty.ToString());
// Result: "5000 mm"

Reference

UnitClassProperty Class
UnitClassProperty Members

Send Feedback