Home
Search
 
What's New
Index
Books
Links
Q & A
Newsletter
Banners
 
Feedback
Tip Jar
 
C# Helper...
 
XML RSS Feed
Follow VBHelper on Twitter
 
 
 
MSDN Visual Basic Community
 
 
 
 
 
TitleUse the FormatPercent function in Visual Basic .NET
DescriptionThis example shows how to use the FormatPercent function in Visual Basic .NET.
KeywordsFormatPercent, format percentage, format percent, percent, percentage, VB.NET
CategoriesStrings, VB.NET
 
The FormatPercent function returns a formatted string representation for a number representing a percentage. It is very similar to FormatNumber except it multiplies the number by 100 and adds a percent character to the result. The syntax is:

    FormatPercent(expression _
        [, digits_after_decimal] _
        [, include_leading_zero] _
        [, use_parens_if_negative] _
        [, groups_digits] )

Where:

expression
The numeric expression to format

digits_after_decimal
The number of digits to display after the decimal point

include_leading_zero
If the number is less than 1 and greater than -1, determines whether the number should have a leading 0 before the decimal point.

use_parens_if_negative
Determines whether negative numbers are surrounded with parentheses instead of using a minus sign.

groups_digits
Determines whether digits to the left of the decimal point are grouped with thousands separators (commas in the United States).

Examples (in the United States):

ExpressionResult
FormatPercent(1.23456, 2)123.46%
FormatPercent(0.123456, 2, TriState.False)12.35%
FormatPercent(0.123456, 2, TriState.True)12.35%
FormatPercent(-12345.12, , TriState.False)-1,234,512.00%
FormatPercent(-12345.12, , TriState.True)(1,234,512.00%)
FormatPercent(-12345.12, , TriState.True, TriState.False)(1234512.00%)

This example uses the following code to display these examples in a TextBox.

 
Private Sub Form1_Load(ByVal sender As System.Object, ByVal _
    e As System.EventArgs) Handles MyBase.Load
    Dim txt As String
    Dim x As Single

    x = 1.23456
    txt &= "FormatPercent(" & x.ToString() & ", 2) = " & _
        FormatPercent(x, 2) & vbCrLf

    x = 0.123456
    txt &= "FormatPercent(" & x.ToString() & ", 2, " & _
        "TriState.false) = " & FormatPercent(x, 2, _
        TriState.False) & vbCrLf
    txt &= "FormatPercent(" & x.ToString() & ", 2, " & _
        "TriState.True) = " & FormatPercent(x, 2, _
        TriState.True) & vbCrLf

    x = -12345.12345
    txt &= "FormatPercent(" & x.ToString() & ", , " & _
        "TriState.False) = " & FormatPercent(x, 2, , _
        TriState.False) & vbCrLf
    txt &= "FormatPercent(" & x.ToString() & ", , " & _
        "TriState.True) = " & FormatPercent(x, 2, , _
        TriState.True) & vbCrLf
    txt &= "FormatPercent(" & x.ToString() & ", , " & _
        "TriState.True, TriState.False) = " & _
        FormatPercent(x, 2, , TriState.True, _
        TriState.False) & vbCrLf

    txtResult.Text = txt
    txtResult.Select(0, 0)
End Sub
 
 
Copyright © 1997-2006 Rocky Mountain Computer Consulting, Inc.   All rights reserved.
  Updated