User Tools

Site Tools


api:dk11:activex:tatukgis_xdk11.itgis_csunits.asareal_double_wordbool_widestring

ITGIS_CSUnits.AsAreal method

DK11 for ActiveX | TatukGIS_XDK11.ITGIS_CSUnits.AsAreal | Methods | Properties

Convert units as areal to string representation with proper units symbol.

Available also on: Delphi | .NET | Java.

Syntax

// C#
public WideString AsAreal(
  double _value,
  WordBool _prec,
  WideString _format
);
' VisualBasic
Public Function AsAreal(
  ByVal _value As Double,
  ByVal _prec As WordBool,
  ByVal _format As WideString
) As WideString
// Oxygene
public
  function AsAreal(
    _value : Double;
    _prec : WordBool;
    _format : WideString
  ) : WideString;

Parameters

Name Type Description
_value double
Double
units in base metric
_prec WordBool if true then fixed decimal digits will be presented; if false then only significant digits (no trailing zeros) will be presented
_format WideString hint of how to present linear symbols: for example by providing 'sq. %s' linear symbols will be presented as '1 sq. km'

Result

Type Description
WideString Units converted to string.

Remarks

Linear units will be autoconverted to areal.
Units of returned string will be autoselected to choose the most adequate is unit is a type of TGIS_CSUnitsType.Auto.

References

2020/05/28 09:03

Page Tools