ActiveReports 19 .NET Edition
MESCIUS.ActiveReports.Core.Data.VBFunctionLib Assembly / GrapeCity.Enterprise.Data.VisualBasicReplacement Namespace / Strings Class / FormatPercent Method
Required. Expression to be formatted.
Optional. Numeric value indicating how many places to the right of the decimal are displayed. Default value is –1, which indicates that the locale settings are used.
Optional. TriState constant that indicates whether or not a leading zero displays for fractional values. See "Settings" for values.
Optional. TriState constant that indicates whether or not to place negative values within parentheses. See "Settings" for values.
Optional. TriState constant that indicates whether or not numbers are grouped using the group delimiter specified in the locale settings. See "Settings" for values.

In This Topic
    FormatPercent Method
    In This Topic
    Returns an expression formatted as a percentage (that is, multiplied by 100) with a trailing % character.
    Syntax
    'Declaration
     
    Public Shared Function FormatPercent( _
       ByVal expression As Object, _
       Optional ByVal numDigitsAfterDecimal As Integer, _
       Optional ByVal includeLeadingDigit As TriState, _
       Optional ByVal useParensForNegativeNumbers As TriState, _
       Optional ByVal groupDigits As TriState _
    ) As String

    Parameters

    expression
    Required. Expression to be formatted.
    numDigitsAfterDecimal
    Optional. Numeric value indicating how many places to the right of the decimal are displayed. Default value is –1, which indicates that the locale settings are used.
    includeLeadingDigit
    Optional. TriState constant that indicates whether or not a leading zero displays for fractional values. See "Settings" for values.
    useParensForNegativeNumbers
    Optional. TriState constant that indicates whether or not to place negative values within parentheses. See "Settings" for values.
    groupDigits
    Optional. TriState constant that indicates whether or not numbers are grouped using the group delimiter specified in the locale settings. See "Settings" for values.

    Return Value

    Returns an expression formatted as a percentage (that is, multiplied by 100) with a trailing % character.
    See Also