AVEVA OMI Software Developer Kit



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

Parameters

num
a float number
formatInfo
formatInfo object containing format specification
lengthLimit
Length Limit to use for formatting
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