Esri Business Analyst Server API for Silverlight 2.2 Reference
FormatValueWithUnits Method
See Also Send Feedback

ESRI.ArcGIS.Client.BACore Namespace > ValueFormatter Class : FormatValueWithUnits Method

Visual Basic (Declaration)
C#

value: A numeric value to be converted.

decimals: The number of significant digits after the decimal point. Negative value means unknown number of digits.

valueType: Type of value.

Converts a numeric value to a string representation with the required number of digits after the decimal point provided with units if necessary.

Syntax

Visual Basic (Declaration)

Public Overridable Function FormatValueWithUnits( _
   ByVal value As Double, _
   ByVal decimals As Integer, _
   ByVal valueType As BAValueType _
) As String

public virtual string FormatValueWithUnits( 
   double value,
   int decimals,
   BAValueType valueType
)

Parameters

value: A numeric value to be converted.
decimals: The number of significant digits after the decimal point. Negative value means unknown number of digits.
valueType: Type of value.

Return Value

String representation of the value.

Remarks

The base version formats the value using the FormatValue method and after that adds units if necessary using the FormatUnits function associated with this formatter.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

Syntax

Parameters

Return Value

Remarks

Requirements

See Also

Reference