AVEVA OMI Software Developer Kit



ArchestrA.Client.NumericFormatter Namespace > NumericFormatter Class > FormatNumber Method : FormatNumber(Double,FormatInfo,Boolean) Method
a double number
formatInfo object containing format specification
specifies whether to apply system regional settings on formatted value. default is true
FormatNumber(Double,FormatInfo,Boolean) Method
Formats the given double number with the specified formatInfo object, using the default length limit.
Syntax
'Declaration
 
Public Overloads MustOverride Function FormatNumber( _
   ByVal num As Double, _
   ByVal formatInfo As FormatInfo, _
   Optional ByVal useRegionalSettings As Boolean _
) As String
'Usage
 
Dim instance As NumericFormatter
Dim num As Double
Dim formatInfo As FormatInfo
Dim useRegionalSettings As Boolean
Dim value As String
 
value = instance.FormatNumber(num, formatInfo, useRegionalSettings)
public abstract string FormatNumber( 
   double num,
   FormatInfo formatInfo,
   bool useRegionalSettings
)
public:
abstract String^ FormatNumber( 
   double num,
   FormatInfo^ formatInfo,
   bool useRegionalSettings
) 

Parameters

num
a double number
formatInfo
formatInfo object containing format specification
useRegionalSettings
specifies whether to apply system regional settings on formatted value. default is true

Return Value

Formatted string
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also