PercentFormatter class

Applies to Windows and Windows Phone

Formats and parses percentages.

Syntax


var percentFormatter = new Windows.Globalization.NumberFormatting.PercentFormatter(iIterable(String));
var percentFormatter = new Windows.Globalization.NumberFormatting.PercentFormatter();

Attributes

[DualApiPartition()]
[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]

Members

The PercentFormatter class has these types of members:

Constructors

The PercentFormatter class has these constructors.

ConstructorDescription
PercentFormatter() Creates a PercentFormatter object and initializes it to default values.
PercentFormatter(IIterable(String), String) Creates a PercentFormatter object initialized by a language list and a geographic region.

 

Methods

The PercentFormatter class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
Format(Double) Returns a string representation of a Double percentage.
Format(Int64) Returns a string representation of an Int64 percentage.
Format(UInt64) Returns a string representation of a UInt64 percentage.
FormatDouble Returns a string representation of a Double percentage.
FormatInt Returns a string representation of an Int64 percentage.
FormatUInt Returns a string representation of a UInt64 percentage.
ParseDouble Attempts to parse a string representation of a Double percentage.
ParseInt Attempts to parse a string representation of an integer percentage.
ParseUInt Attempts to parse a string representation of an unsigned integer percentage.

 

Properties

The PercentFormatter class has these properties.

PropertyAccess typeDescription

FractionDigits

Read/writeGets or sets the minimum number of digits to display for the fraction part of the percentage.

GeographicRegion

Read-onlyGets the region that is used when formatting and parsing percentages.

IntegerDigits

Read/writeGets or sets the minimum number of digits to display for the integer part of the percentage.

IsDecimalPointAlwaysDisplayed

Read/writeGets or sets whether the decimal point of the percentage should always be displayed.

IsGrouped

Read/writeGets or sets whether the integer part of the percentage should be grouped.

IsZeroSigned

Read/writeGets or sets whether -0 is formatted as -0 or 0.

Languages

Read-onlyGets the priority list of language identifiers that is used when formatting and parsing percentages.

NumberRounder

Read/writeGets or sets the current rounding strategy to be used when formatting percents.

NumeralSystem

Read/writeGets or sets the numbering system that is used to format and parse percentages.

ResolvedGeographicRegion

Read-onlyGets the geographic region that was most recently used to format or parse percent values.

ResolvedLanguage

Read-onlyGets the language that was most recently used to format or parse percent values.

SignificantDigits

Read/writeGets or sets the current padding to significant digits when a percent is formatted.

 

Remarks

Note  If your app passes language tags used in this class to any National Language Support functions, it must first convert the tags by calling ResolveLocaleName.

Examples


// This scenario uses the Windows.Globalization.NumberFormatting.PercentFormatter and
// the Windows.Globalization.NumberFormatting.PermilleFormatter classes to format numbers
// as a percent or a permille.

// Create formatters initialized using the current user's preference settings.
var percentFormat = new Windows.Globalization.NumberFormatting.PercentFormatter();
var permilleFormat = new Windows.Globalization.NumberFormatting.PermilleFormatter();

// Make a random number.
var randomNumber = Math.random();

// Format with current user preferences.
var percent = percentFormat.format(randomNumber);
var permille = permilleFormat.format(randomNumber);

// Get a fixed number.
var fixedNumber = 500;

// Format with grouping using default.
var percentFormat1 = new Windows.Globalization.NumberFormatting.PercentFormatter();
percentFormat1.isGrouped = true;
var percent1 = percentFormat1.format(fixedNumber);

// Format with grouping using French.
var percentFormatFR = new Windows.Globalization.NumberFormatting.PercentFormatter(["fr-FR"], "FR");
percentFormatFR.isGrouped = true;
var percentFR = percentFormatFR.format(fixedNumber);

// Format with no fractional digits using default.
var percentFormat2 = new Windows.Globalization.NumberFormatting.PercentFormatter();
percentFormat2.fractionDigits = 0;
var percent2 = percentFormat2.format(fixedNumber);

// Format always with a decimal point.
var percentFormat3 = new Windows.Globalization.NumberFormatting.PercentFormatter();
percentFormat3.isDecimalPointAlwaysDisplayed = true;
percentFormat3.fractionDigits = 0;
var percent3 = percentFormat3.format(fixedNumber);

// Display the results.
var results = "Random number (" + randomNumber + ")\n" +
              "Percent formatted: " + percent + "\n" +
              "Permille formatted: " + permille + "\n\n" +
              "Fixed number (" + fixedNumber + ")\n" +
              "Percent formatted (grouped): " + percent1 + "\n" +
              "Percent formatted (grouped as fr-FR): " + percentFR + "\n" +
              "Percent formatted (no fractional digits): " + percent2 + "\n" +
              "Percent formatted (always with a decimal point): " + percent3;

Requirements

Minimum supported client

Windows 8 [Windows Store apps, desktop apps]

Minimum supported server

Windows Server 2012 [Windows Store apps, desktop apps]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.Globalization.NumberFormatting
Windows::Globalization::NumberFormatting [C++]

Metadata

Windows.winmd

See also

Number formatting and parsing sample
Object
INumberFormatterOptions
INumberFormatter
INumberFormatter2
INumberParser
ISignificantDigitsOption
INumberRounderOption

 

 

Show:
© 2014 Microsoft