Conversions Methods

The Conversions object contains the following methods:

ConvertValue

The ConvertValue method converts the provided value from its source units to the destination units.

Syntax

ConvertValue(Value As Integer, UnitsSource As String, UnitsDestination As String) As String

Parameters

Remarks

Return Value: Value after it has been converted into UnitsDestination.

Example

The following method converts 9001 centimeters to meters.

1
2
3
4
5
6
7
8
9
10
11
Sub conValue()
    Dim objConversion
    Set objConversion = CreateObject("CxScript.Conversions")
     
    Dim iRet, iValue, strSource, strDest
    iValue = 9001
    strSource = "cm"
    strDest = "m"
    iRet = objConversion.ConvertValue(ivlaue, strSource, strDest)
    edtMessageBox.Text = iValue & strSource & " is equal to " & iRet & strDest
End Sub

GetAllCategories

The GetAllCategories method returns a list of all unit categories by their integer identifier. It does not return the category name string. GetCategoryName can be used in conjunction to get a human-readable name.

Syntax

GetAllCategories() As Variant

Remarks

Return Value: List of all unit categories by their integer identifier.

Example

The following example retrieves all unit category IDs, category names, units for each category, and the unit descriptions.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
Dim objConversions
    Set objConversions = CreateObject ("CxScript.Conversions")
     
    ' get all unit category IDs
    Dim arrCategories
    arrCategories = objConversions.GetAllCategories
     
    Dim strUnit
    Dim strUnitDesc
    Dim arrUnits
    Dim nCategory
    Dim strCategoryName
     
    For Each nCategory In arrCategories
        ' now that we have the ID for the category, get its name
        strCategoryName = objConversions.GetCategoryName(nCategory)
         
        ' get the units for this category
        arrUnits = objConversions.GetUnitsForCategory(nCategory)
         
        For Each strUnit In arrUnits
            strUnitDesc = objConversions.GetUnitDescription(strUnit)
         
        ' TODO: store category ID, category name, unit name, and unit description                 
    Next                    
Next

GetAllUnitNames

The GetAllUnitNames method retrieves all valid unit names (optionally abbreviates them).

Syntax

GetAllUnitNames(Abbreviate As Boolean) As Variant

Parameters

Remarks

Return Value: An array of all unit names.

Example

The following example gets the unabbreviated names of all units and displays them in a list box.

1
2
3
4
5
6
7
8
9
Sub getUnitNames()
    Dim arrNames, item, objConversion
    Set objConversion = CreateObject("CxScript.Conversions")
     
    arrNames = objConversion.GetAllUnitNames(False)
    For Each item In arrNames
        lstUnits.AddString(item)
    Next
End Sub

GetCategoryName

The GetGategoryName method returns the name for the provided unit category identifier.

Syntax

GetCategoryName(Category As Integer) As String

Parameters

Remarks

Return Value: The human-readable name of the unit category.

Example

See the example for GetAllCategories.

GetConvertableUnitNames

The GetConvertableUnitNames method retrieves all unit names to which the provided unit name can be converted.

Syntax

GetConvertableUnitNames(Units As String, Abbreviate As Boolean) As Variant

Parameters

Remarks

Return Value: An array of all convertible unit names. If Units is invalid, an empty array is returned.

Example

The following example gets all the units that meters can be converted into.

1
2
3
4
5
6
7
8
9
Sub getConvertableNames()
    Dim arrNames, item, objConversion
    Set objConversion = CreateObject("CxScript.Conversions")
     
    arrNames = objConversion.GetConvertableUnitNames("meters", False)
    For Each item In arrNames
        lstUnits.AddString(item)
    Next
End Sub

GetUnitDescription

The GetUnitDescription method returns the long name for a given unit. For example, providing "m" will return "meters".

Syntax

GetUnitDescription(Unit As String) As String

Parameter

Remarks

Return Value: The long name of the given unit.

Example

See the example for GetAllCategories.

GetUnitsForCategory

The GetUnitsForCategory method returns a list of all units for the provided unit category. The unit name as a string will be in the returned array.

Syntax

GetUnitsForCategory(Category As Integer) As Variant

Parameter

Remarks

Return Value: An array of all unit names.

Example

See the example for GetAllCategories.

IsConvertable

The IsConvertable method determines if there is a valid conversion between the provided unit names.

Syntax

IsConvertable(UnitsSource As String, UnitsDestination As String) As Boolean

Parameters

Remarks

Return Value: A Boolean indicating whether the two units are convertible.

Example

The following example checks if meters is convertible to kilometers.

1
2
3
4
5
6
Sub isConvertible()
    Dim objConversion
    Set objConversion = CreateObject("CxScript.Conversions")
     
    Msgbox objConversion.isConvertable("meters", "kilometers")  'Returns True
End Sub

SetBarAirPressure

The SetBarAirPressure method overrides the conversion library’s default air pressure value used to convert from gauge to absolute pressure.

Syntax

SetBarAirPressure(BarAirPressure As Double)

Parameter

Example

The following example sets the barometric air pressure to 1.0132 bars.

1
2
3
4
5
6
7
Sub setBarPressure()
    Dim objConversion
    Set objConversion = CreateObject("CxScript.Conversions")
     
    objConversion.SetBarAirPressure(1.01320)
    edtMessageBox.Text = "Bar pressure set"
End Sub