VB.NET FormatNumber() – Code Sample Syntax Example

VB.NET FormatNumber Example – Code Sample Syntax

Abstract: – Illustrates using .

 *** 1. Download Source Code *** 

VB.NET Syntax StringManipulation FormatNumber download Download Source Code for All VB Console Examples in One Project

 *** 2. FormatNumber Syntax *** 


Purpose:
Returns expression formatted as a number


Syntax:
FormatNumber (Expression As Object, _
NumDigitsAfterDecimal As Integer, _
IncludeLeadingDigit As TriState, _
UseParensForNegativeNumbers As TriState, _
GroupDigits As TriState _
) As String

Parameters Description
Expression Required – Expression to be formatted
NumDigitsAfterDecimal Optional – Numeric value indicating how
many places are displayed to the right of the decimal. Default value is –1,
which indicates that the computers regional settings are used.
IncludeLeadingDigit Optional. TriState enumeration that
indicates whether or not a leading zero is displayed for fractional values.
UseParensForNegativeNumbers Optional. TriState enumeration
that indicates whether or not to place negative values within parentheses.
GroupDigits Optional. TriState enumeration that indicates
whether or not numbers are grouped using the group delimiter specified
in the computers regional settings.

Result Data Type Description
string Returns string formatted as a number


 *** 3. FormatNumber – Quick Example *** 

Dim dblNumber As Double = -5432.43
‘ Returns “(5,432.430)”.
Console.WriteLine(FormatNumber(dblNumber, 3, , TriState.True, TriState.True))

 *** 4. FormatNumber – Full Example *** 

FormatNumber Example Output Screenshot


VB.NET Syntax StringManipulation FormatNumber screenshot


Step 1: Click Visual Basic to Cut-n-paste code into clsFormatNumber.vb

Public Class clsFormatNumber
 
    Public Sub Main()
 
 
        '****************************************************************************************
        ' Purpose:  Returns expression formatted as a number
        '
        ' Syntax: 	FormatNumber (Expression As Object, _
        ' NumDigitsAfterDecimal As Integer, _
        ' IncludeLeadingDigit As TriState, _
        ' UseParensForNegativeNumbers As TriState, _
        ' GroupDigits As TriState _
        ' ) As String
        '
        ' Parameter1: Expression - Required - Expression to be formatted
        '
        ' Parameter2: NumDigitsAfterDecimal - Optional - Numeric value indicating how 
        ' many places are displayed to the right of the decimal. Default value is –1, 
        ' which indicates that the computer's regional settings are used.
        '
        ' Parameter3: IncludeLeadingDigit - Optional. TriState enumeration that 
        ' indicates whether or not a leading zero is displayed for fractional values. 
        '
        ' Parameter4: UseParensForNegativeNumbers - Optional. TriState enumeration 
        ' that indicates whether or not to place negative values within parentheses. 
        '
        ' Parameter5: GroupDigits - Optional. TriState enumeration that indicates 
        ' whether or not numbers are grouped using the group delimiter specified 
        ' in the computer's regional settings. 
        '
        ' Result: string - Returns string formatted as a number
        '
        ' Quick Example:  Dim dblNumber As Double = -5432.43
        ' ' Returns "(5,432.430)".
        ' Console.WriteLine(FormatNumber(dblNumber, 3, , TriState.True, TriState.True))
        '
        ' 
        '****************************************************************************************
 
        Console.WriteLine("Example #1: 	FormatNumber (Expression As Object," & _
        " NumDigitsAfterDecimal As Integer," & _
        " IncludeLeadingDigit As TriState," & _
         " UseParensForNegativeNumbers As TriState," & _
        " GroupDigits As TriState " & _
         " ) As String ")
        Dim dblNumber As Double = -5432.43
 
        ' Returns "(5,432.430)".
        Console.WriteLine(FormatNumber(dblNumber, 3, , TriState.True, TriState.True))
 
 
        'write blank line to make output easier to read
        Console.WriteLine()
 
 
 
        'Prevent console from closing before you press enter
        Console.ReadLine()
 
    End Sub
 
 
End Class

Step 2: Click Visual Basic to Cut-n-paste code into Module1.vb

Module Module1
 
    Sub Main()
 
 
        Dim myclsFormatNumber As New clsFormatNumber
        myclsFormatNumber.Main()
 
 
 
    End Sub
 
End Module

Prerequistes:

  1. Install Visual Basic (Express or Standard Edition)
  2. Install SQL Server Express
  3. Download Northwind and pubs Database
  4. Attach Northwind Database to Databases in Sql Express
  5. Attach pubs Database to Databases in Sql Express

Notes:

  • Console Application is used to simplify things, but Windows Forms or Web Forms could also be used
  • You can build a library of syntax examples by using same project over and over and just commenting out what you do not want to execute in Module1.vb

Instructions:
VB.NET Syntax StringManipulation FormatNumber

  1. Use Visual Basic 2010 Express or Standard Edition
  2. Create new project;
    • Click File/New Project
    • Select Console Application Template
    • Select Visual Basic for Language
    • name of project could be VBNET_Syntax.
  3. Add New folder named “StringManipulation”
    • Right-click project name in solution explorer;
    • add new folder;
    • name of folder could be: StringManipulation
  4. Add Class Named clsFormatNumber to StringManipulation folder
    • Right-click StringManipulation folder;
    • add new item;
    • Select class
    • Class name could be clsFormatNumber
  5. Click on Visual Basic in code in step 1 above to copy code into clsFormatNumber.vb
  6. Click on Visual Basic in code in step 2 above to copy code into Module1.vb
  7. Click green arrow or press F5 to run program